complex128.h

// Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <stdint.h>

#include <complex>
#include <cstring>
#include <iostream>
#include <limits>

#ifdef PADDLE_WITH_CUDA
#include <cuComplex.h>
#include <thrust/complex.h>
#endif  // PADDLE_WITH_CUDA

#ifdef PADDLE_WITH_HIP
#include <hip/hip_complex.h>
#include <thrust/complex.h>  // NOLINT
#endif

#if !defined(_WIN32)
#define PADDLE_ALIGN(x) __attribute__((aligned(x)))
#else
#define PADDLE_ALIGN(x) __declspec(align(x))
#endif

#if (defined(__CUDACC__) || defined(__HIPCC__))
#define HOSTDEVICE __host__ __device__
#define DEVICE __device__
#define HOST __host__
#else
#define HOSTDEVICE
#define DEVICE
#define HOST
#endif

#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)
#define PADDLE_WITH_CUDA_OR_HIP_COMPLEX128
#endif

namespace paddle {
namespace platform {

struct PADDLE_ALIGN(16) complex128 {
 public:
  double real;
  double imag;

  complex128() = default;
  complex128(const complex128& o) = default;
  complex128& operator=(const complex128& o) = default;
  complex128(complex128&& o) = default;
  complex128& operator=(complex128&& o) = default;
  ~complex128() = default;

  HOSTDEVICE complex128(double real, double imag) : real(real), imag(imag) {}
#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)

  HOSTDEVICE inline explicit complex128(const thrust::complex<double>& c) {
    real = c.real();
    imag = c.imag();
  }

  HOSTDEVICE inline explicit operator thrust::complex<double>() const {
    return thrust::complex<double>(real, imag);
  }

#ifdef PADDLE_WITH_HIP
  HOSTDEVICE inline explicit operator hipDoubleComplex() const {
    return make_hipDoubleComplex(real, imag);
  }
#else
  HOSTDEVICE inline explicit operator cuDoubleComplex() const {
    return make_cuDoubleComplex(real, imag);
  }
#endif
#endif

  HOSTDEVICE complex128(const float& val)
      : real(static_cast<double>(val)), imag(0) {}
  HOSTDEVICE complex128(const double& val) : real(val), imag(0) {}
  HOSTDEVICE complex128(const int& val)
      : real(static_cast<double>(val)), imag(0) {}
  HOSTDEVICE complex128(const int64_t& val)
      : real(static_cast<double>(val)), imag(0) {}

  HOSTDEVICE inline explicit operator std::complex<double>() {
    return static_cast<std::complex<double>>(std::complex<double>(real, imag));
  }

  template <class T>
  HOSTDEVICE inline explicit complex128(const T& val)
      : real(complex128(static_cast<double>(val)).real) {}

  HOSTDEVICE complex128(const std::complex<double> val)
      : real(val.real()), imag(val.imag()) {}

  HOSTDEVICE inline complex128& operator=(bool b) {
    real = b ? 1 : 0;
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(int8_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(uint8_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(int16_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(uint16_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(int32_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(uint32_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(int64_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(uint64_t val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(float val) {
    real = val;
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline complex128& operator=(double val) {
    real = static_cast<double>(val);
    imag = 0;
    return *this;
  }

  HOSTDEVICE inline operator float() const {
    return static_cast<float>(this->real);
  }

  HOSTDEVICE inline explicit operator bool() const {
    return static_cast<bool>(this->real) || static_cast<bool>(this->imag);
  }

  HOSTDEVICE inline explicit operator int8_t() const {
    return static_cast<int8_t>(this->real);
  }

  HOSTDEVICE inline explicit operator uint8_t() const {
    return static_cast<uint8_t>(this->real);
  }

  HOSTDEVICE inline explicit operator int16_t() const {
    return static_cast<int16_t>(this->real);
  }

  HOSTDEVICE inline explicit operator uint16_t() const {
    return static_cast<uint16_t>(this->real);
  }

  HOSTDEVICE inline explicit operator int32_t() const {
    return static_cast<int32_t>(this->real);
  }

  HOSTDEVICE inline explicit operator uint32_t() const {
    return static_cast<uint32_t>(this->real);
  }

  HOSTDEVICE inline explicit operator int64_t() const {
    return static_cast<int64_t>(this->real);
  }

  HOSTDEVICE inline explicit operator uint64_t() const {
    return static_cast<uint64_t>(this->real);
  }

  HOSTDEVICE inline explicit operator double() const {
    return static_cast<double>(this->real);
  }
};

HOSTDEVICE inline complex128 operator+(const complex128& a,
                                       const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::complex<double>(a.real, a.imag) +
                    thrust::complex<double>(b.real, b.imag));
#else
  return complex128(a.real + b.real, a.imag + b.imag);
#endif
}

HOSTDEVICE inline complex128 operator-(const complex128& a,
                                       const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::complex<double>(a.real, a.imag) -
                    thrust::complex<double>(b.real, b.imag));
#else
  return complex128(a.real - b.real, a.imag - b.imag);
#endif
}

HOSTDEVICE inline complex128 operator*(const complex128& a,
                                       const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::complex<double>(a.real, a.imag) *
                    thrust::complex<double>(b.real, b.imag));
#else
  return complex128(a.real * b.real - a.imag * b.imag,
                    a.imag * b.real + b.imag * a.real);
#endif
}

HOSTDEVICE inline complex128 operator/(const complex128& a,
                                       const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::complex<double>(a.real, a.imag) /
                    thrust::complex<double>(b.real, b.imag));
#else
  double denominator = b.real * b.real + b.imag * b.imag;
  return complex128((a.real * b.real + a.imag * b.imag) / denominator,
                    (a.imag * b.real - a.real * b.imag) / denominator);
#endif
}

HOSTDEVICE inline complex128 operator-(const complex128& a) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(-thrust::complex<double>(a.real, a.imag));
#else
  complex128 res;
  res.real = -a.real;
  res.imag = -a.imag;
  return res;
#endif
}

HOSTDEVICE inline complex128& operator+=(complex128& a,  // NOLINT
                                         const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  a = complex128(thrust::complex<double>(a.real, a.imag) +=
                 thrust::complex<double>(b.real, b.imag));
  return a;
#else
  a.real += b.real;
  a.imag += b.imag;
  return a;
#endif
}

HOSTDEVICE inline complex128& operator-=(complex128& a,  // NOLINT
                                         const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  a = complex128(thrust::complex<double>(a.real, a.imag) -=
                 thrust::complex<double>(b.real, b.imag));
  return a;
#else
  a.real -= b.real;
  a.imag -= b.imag;
  return a;
#endif
}

HOSTDEVICE inline complex128& operator*=(complex128& a,  // NOLINT
                                         const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  a = complex128(thrust::complex<double>(a.real, a.imag) *=
                 thrust::complex<double>(b.real, b.imag));
  return a;
#else
  a.real = a.real * b.real - a.imag * b.imag;
  a.imag = a.imag * b.real + b.imag * a.real;
  return a;
#endif
}

HOSTDEVICE inline complex128& operator/=(complex128& a,  // NOLINT
                                         const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  a = complex128(thrust::complex<double>(a.real, a.imag) /=
                 thrust::complex<double>(b.real, b.imag));
  return a;
#else
  double denominator = b.real * b.real + b.imag * b.imag;
  a.real = (a.real * b.real + a.imag * b.imag) / denominator;
  a.imag = (a.imag * b.real - a.real * b.imag) / denominator;
  return a;
#endif
}

HOSTDEVICE inline complex128 raw_uint16_to_complex128(uint16_t a) {
  complex128 res;
  res.real = a;
  return res;
}

HOSTDEVICE inline bool operator==(const complex128& a, const complex128& b) {
  return a.real == b.real && a.imag == b.imag;
}

HOSTDEVICE inline bool operator!=(const complex128& a, const complex128& b) {
  return a.real != b.real || a.imag != b.imag;
}

HOSTDEVICE inline bool operator<(const complex128& a, const complex128& b) {
  return static_cast<double>(a.real) < static_cast<double>(b.real);
}

HOSTDEVICE inline bool operator<=(const complex128& a, const complex128& b) {
  return static_cast<double>(a.real) <= static_cast<double>(b.real);
}

HOSTDEVICE inline bool operator>(const complex128& a, const complex128& b) {
  return static_cast<double>(a.real) > static_cast<double>(b.real);
}

HOSTDEVICE inline bool operator>=(const complex128& a, const complex128& b) {
  return static_cast<double>(a.real) >= static_cast<double>(b.real);
}

HOSTDEVICE inline bool(isnan)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA) && defined(__CUDA_ARCH__)
  // __isnanf not supported on HIP platform
  return __isnan(a.real) || __isnan(a.imag);
#else
  return std::isnan(a.real) || std::isnan(a.imag);
#endif
}

HOSTDEVICE inline bool(isinf)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA) && defined(__CUDA_ARCH__)
  // __isinf not supported on HIP platform
  return __isinf(a.real) || __isinf(a.imag);
#else
  return std::isinf(a.real) || std::isinf(a.imag);
#endif
}

HOSTDEVICE inline bool(isfinite)(const complex128& a) {
  return !((isnan)(a)) && !((isinf)(a));
}

HOSTDEVICE inline double(abs)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return thrust::abs(thrust::complex<double>(a.real, a.imag));
#else
  return std::abs(std::complex<double>(a.real, a.imag));
#endif
}

HOSTDEVICE inline complex128(pow)(const complex128& a, const complex128& b) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::pow(thrust::complex<double>(a.real, a.imag),
                                thrust::complex<double>(b.real, b.imag)));
#else
  return std::pow(std::complex<double>(a), std::complex<float>(b));
#endif
}

HOSTDEVICE inline complex128(sqrt)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::sqrt(thrust::complex<double>(a.real, a.imag)));
#else
  return std::sqrt(std::complex<double>(a));
#endif
}

HOSTDEVICE inline complex128(tanh)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::tanh(thrust::complex<double>(a.real, a.imag)));
#else
  return std::tanh(std::complex<double>(a));
#endif
}

HOSTDEVICE inline complex128(log)(const complex128& a) {
#if defined(PADDLE_WITH_CUDA_OR_HIP_COMPLEX128) && \
    (defined(__CUDA_ARCH__) || defined(__HIPCC__))
  return complex128(thrust::log(thrust::complex<double>(a.real, a.imag)));
#else
  return complex128(std::log(std::complex<double>(a)));
#endif
}

inline std::ostream& operator<<(std::ostream& os, const complex128& a) {
  os << "real:" << a.real << " imag:" << a.imag;
  return os;
}

}  // namespace platform
}  // namespace paddle

namespace std {

template <>
struct is_pod<paddle::platform::complex128> {
  static const bool value =
      is_trivial<paddle::platform::complex128>::value &&
      is_standard_layout<paddle::platform::complex128>::value;
};

template <>
struct is_floating_point<paddle::platform::complex128>
    : std::integral_constant<
          bool, std::is_same<paddle::platform::complex128,
                             typename std::remove_cv<
                                 paddle::platform::complex128>::type>::value> {
};
template <>
struct is_signed<paddle::platform::complex128> {
  static const bool value = false;
};

template <>
struct is_unsigned<paddle::platform::complex128> {
  static const bool value = false;
};

inline bool isnan(const paddle::platform::complex128& a) {
  return paddle::platform::isnan(a);
}

inline bool isinf(const paddle::platform::complex128& a) {
  return paddle::platform::isinf(a);
}

template <>
struct numeric_limits<paddle::platform::complex128> {
  static const bool is_specialized = false;
  static const bool is_signed = false;
  static const bool is_integer = false;
  static const bool is_exact = false;
  static const bool has_infinity = false;
  static const bool has_quiet_NaN = false;
  static const bool has_signaling_NaN = false;
  static const float_denorm_style has_denorm = denorm_absent;
  static const bool has_denorm_loss = false;
  static const std::float_round_style round_style = std::round_toward_zero;
  static const bool is_iec559 = false;
  static const bool is_bounded = false;
  static const bool is_modulo = false;
  static const int digits = 0;
  static const int digits10 = 0;
  static const int max_digits10 = 0;
  static const int radix = 0;
  static const int min_exponent = 0;
  static const int min_exponent10 = 0;
  static const int max_exponent = 0;
  static const int max_exponent10 = 0;
  static const bool traps = false;
  static const bool tinyness_before = false;

  static paddle::platform::complex128(min)() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 lowest() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128(max)() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 epsilon() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 round_error() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 infinity() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 quiet_NaN() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 signaling_NaN() {
    return paddle::platform::complex128(0.0, 0.0);
  }
  static paddle::platform::complex128 denorm_min() {
    return paddle::platform::complex128(0.0, 0.0);
  }
};

}  // namespace std

#define MKL_Complex16 paddle::platform::complex128