paddlepaddle--paddle/paddle/phi/kernels/funcs/complex_functors.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
#ifndef _USE_MATH_DEFINES
#define _USE_MATH_DEFINES
#endif
#include <cmath>
// TODO(toolchain-cxx20): GCC < 11 and Windows builds are temporarily kept on
// C++17. Remove this fallback after all build paths use C++20.
#if __cplusplus >= 202002L && !defined(__CUDACC__) && !defined(__HIPCC__)
#include <numbers>  // NOLINT(build/include_order)
#endif
#include <type_traits>

#include "paddle/common/hostdevice.h"
#include "paddle/phi/common/type_traits.h"

namespace phi {
namespace funcs {

template <typename T, typename RealT>
using Complex = typename std::enable_if<!std::is_same<T, RealT>::value>::type;

// There are no NoComplex cases now, implement later if needed
template <typename T, typename RealT>
using NoComplex = typename std::enable_if<std::is_same<T, RealT>::value>::type;

template <typename T>
using EnableComplex =
    typename std::enable_if<std::is_same<T, phi::complex64>::value ||
                            std::is_same<T, phi::complex128>::value>::type;

template <typename T>
using DisableComplex =
    typename std::enable_if<!std::is_same<T, phi::complex64>::value &&
                            !std::is_same<T, phi::complex128>::value>::type;

template <typename T, typename Enable = void>
struct RealFunctor;

template <typename T>
struct RealFunctor<T, Complex<T, dtype::Real<T>>> {
 public:
  RealFunctor(const T* input, dtype::Real<T>* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx] = input_[idx].real;
  }

 private:
  const T* input_;
  dtype::Real<T>* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct ImagFunctor;

template <typename T>
struct ImagFunctor<T, Complex<T, dtype::Real<T>>> {
  ImagFunctor(const T* input, dtype::Real<T>* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx] = input_[idx].imag;
  }

  const T* input_;
  dtype::Real<T>* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct AbsFunctor;

template <typename T>
struct AbsFunctor<T, Complex<T, dtype::Real<T>>> {
  AbsFunctor(const T* input, dtype::Real<T>* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx] = abs(input_[idx]);
  }

  const T* input_;
  dtype::Real<T>* output_;
  int64_t numel_;
};

template <typename T>
struct AbsFunctor<T, NoComplex<T, dtype::Real<T>>> {
  AbsFunctor(const T* input, T* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx] = std::abs(input_[idx]);
  }

  const T* input_;
  T* output_;
  int64_t numel_;
};

template <typename T>
struct AbsGradFunctor {
  AbsGradFunctor(const dtype::Real<T>* dout,
                 const T* x,
                 T* output,
                 int64_t numel)
      : dout_(dout), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == T(0)) {
      output_[idx] = T(0);
    } else {
      output_[idx] = T(dout_[idx]) * (x_[idx] / T(std::abs(x_[idx])));
    }
  }

  const dtype::Real<T>* dout_;
  const T* x_;
  T* output_;
  int64_t numel_;
};

template <>
struct AbsGradFunctor<phi::bfloat16> {
  AbsGradFunctor(const dtype::Real<phi::bfloat16>* dout,
                 const phi::bfloat16* x,
                 phi::bfloat16* output,
                 int64_t numel)
      : dout_(dout), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == static_cast<phi::bfloat16>(0)) {
      output_[idx] = static_cast<phi::bfloat16>(0);
    } else {
      output_[idx] = dout_[idx] * (x_[idx] / (abs(x_[idx])));
    }
  }

  const dtype::Real<phi::bfloat16>* dout_;
  const phi::bfloat16* x_;
  phi::bfloat16* output_;
  int64_t numel_;
};

template <>
struct AbsGradFunctor<phi::complex64> {
  AbsGradFunctor(const float* dout,
                 const phi::complex64* x,
                 phi::complex64* output,
                 int64_t numel)
      : dout_(dout), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == phi::complex64(0)) {
      output_[idx] = phi::complex64(0);
    } else {
      output_[idx] =
          phi::complex64(dout_[idx]) * (x_[idx] / phi::complex64(abs(x_[idx])));
    }
  }

  const float* dout_;
  const phi::complex64* x_;
  phi::complex64* output_;
  int64_t numel_;
};

template <>
struct AbsGradFunctor<phi::complex128> {
  AbsGradFunctor(const double* dout,
                 const phi::complex128* x,
                 phi::complex128* output,
                 int64_t numel)
      : dout_(dout), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == phi::complex128(0)) {
      output_[idx] = phi::complex128(0);
    } else {
      output_[idx] = phi::complex128(dout_[idx]) *
                     (x_[idx] / phi::complex128(abs(x_[idx])));
    }
  }

  const double* dout_;
  const phi::complex128* x_;
  phi::complex128* output_;
  int64_t numel_;
};

template <typename T>
struct AbsGradGradFunctor {
  AbsGradGradFunctor(const T* ddx, const T* x, T* output, int64_t numel)
      : ddx_(ddx), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == T(0)) {
      output_[idx] = T(0);
    } else {
      output_[idx] = T(ddx_[idx]) * x_[idx] / T(std::abs(x_[idx]));
    }
  }

  const T* ddx_;
  const T* x_;
  T* output_;
  int64_t numel_;
};

template <>
struct AbsGradGradFunctor<phi::complex128> {
  AbsGradGradFunctor(const phi::complex128* ddx,
                     const phi::complex128* x,
                     phi::complex128* output,
                     int64_t numel)
      : ddx_(ddx), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == phi::complex128(0)) {
      output_[idx] = phi::complex128(0);
    } else {
      output_[idx] =
          phi::complex128(ddx_[idx]) * x_[idx] / phi::complex128(abs(x_[idx]));
    }
  }

  const phi::complex128* ddx_;
  const phi::complex128* x_;
  phi::complex128* output_;
  int64_t numel_;
};

template <>
struct AbsGradGradFunctor<phi::complex64> {
  AbsGradGradFunctor(const phi::complex64* ddx,
                     const phi::complex64* x,
                     phi::complex64* output,
                     int64_t numel)
      : ddx_(ddx), x_(x), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == phi::complex64(0)) {
      output_[idx] = phi::complex64(0);
    } else {
      output_[idx] =
          phi::complex64(ddx_[idx]) * x_[idx] / phi::complex64(abs(x_[idx]));
    }
  }

  const phi::complex64* ddx_;
  const phi::complex64* x_;
  phi::complex64* output_;
  int64_t numel_;
};
template <typename T, typename Enable = void>
struct RealToComplexFunctor;

template <typename T>
struct RealToComplexFunctor<T, Complex<T, dtype::Real<T>>> {
  RealToComplexFunctor(const dtype::Real<T>* input, T* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx].real = input_[idx];
    output_[idx].imag = 0;
  }

  const dtype::Real<T>* input_;
  T* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct ImagToComplexFunctor;

template <typename T>
struct ImagToComplexFunctor<T, Complex<T, dtype::Real<T>>> {
  ImagToComplexFunctor(const dtype::Real<T>* input, T* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx].real = 0;
    output_[idx].imag = input_[idx];
  }

  const dtype::Real<T>* input_;
  T* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct RealImagToComplexFunctor;

template <typename T>
struct RealImagToComplexFunctor<T, Complex<T, dtype::Real<T>>> {
  RealImagToComplexFunctor(const dtype::Real<T>* input_real,
                           const dtype::Real<T>* input_imag,
                           T* output,
                           int64_t numel)
      : input_real_(input_real),
        input_imag_(input_imag),
        output_(output),
        numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx].real = input_real_[idx];
    output_[idx].imag = input_imag_[idx];
  }

  const dtype::Real<T>* input_real_;
  const dtype::Real<T>* input_imag_;
  T* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct ConjFunctor;

template <typename T>
struct ConjFunctor<T, EnableComplex<T>> {
  ConjFunctor(const T* input, int64_t numel, T* output)
      : input_(input), numel_(numel), output_(output) {}

  HOSTDEVICE void operator()(size_t idx) const {
    output_[idx] = T(input_[idx].real, -input_[idx].imag);
  }
  const T* input_;
  int64_t numel_;
  T* output_;
};

template <typename T>
struct ConjFunctor<T, DisableComplex<T>> {
  ConjFunctor(const T* input, int64_t numel, T* output)
      : input_(input), numel_(numel), output_(output) {}

  HOSTDEVICE void operator()(size_t idx) const { output_[idx] = input_[idx]; }
  const T* input_;
  int64_t numel_;
  T* output_;
};

template <typename T, typename Enable = void>
struct AngleFunctor;

// angel function for complex
template <typename T>
struct AngleFunctor<T, funcs::Complex<T, dtype::Real<T>>> {
  AngleFunctor(const T* input, dtype::Real<T>* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    output_[idx] = arg(input_[idx]);
  }

  const T* input_;
  dtype::Real<T>* output_;
  int64_t numel_;
};

// angel function for real
template <typename T>
struct AngleFunctor<T, funcs::NoComplex<T, dtype::Real<T>>> {
  AngleFunctor(const T* input, T* output, int64_t numel)
      : input_(input), output_(output), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if constexpr (std::is_same_v<T, phi::bfloat16> ||
                  std::is_same_v<T, phi::float16>) {
      if (phi::dtype::isnan(input_[idx])) {
        output_[idx] = input_[idx];
        return;
      }
    } else if constexpr (std::is_floating_point_v<T>) {
#if defined(__CUDACC__) || defined(__HIPCC__)
      if (::isnan(input_[idx])) {
        output_[idx] = input_[idx];
        return;
      }
#else
      if (std::isnan(input_[idx])) {
        output_[idx] = input_[idx];
        return;
      }
#endif
    }
    output_[idx] = input_[idx] < static_cast<T>(0)
#if __cplusplus >= 202002L && !defined(__CUDACC__) && !defined(__HIPCC__)
                       ? static_cast<T>(std::numbers::pi_v<double>)
#else
                       ? static_cast<T>(M_PI)
#endif
                       : static_cast<T>(0);
  }

  const T* input_;
  T* output_;
  int64_t numel_;
};

template <typename T, typename Enable = void>
struct AngleGradFunctor;

// angle grad for complex
template <typename T>
struct AngleGradFunctor<T, funcs::Complex<T, dtype::Real<T>>> {
  AngleGradFunctor(const dtype::Real<T>* dout, const T* x, T* dx, int64_t numel)
      : dout_(dout), x_(x), dx_(dx), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const {
    if (x_[idx] == T(0)) {
      dx_[idx] = T(0);
    } else {
      const phi::dtype::Real<T> r_square =
          x_[idx].real * x_[idx].real + x_[idx].imag * x_[idx].imag;
      dx_[idx] = T(-dout_[idx] * x_[idx].imag / r_square,
                   dout_[idx] * x_[idx].real / r_square);
    }
  }

  const phi::dtype::Real<T>* dout_;
  const T* x_;
  T* dx_;
  int64_t numel_;
};

// angle grad for real
template <typename T>
struct AngleGradFunctor<T, funcs::NoComplex<T, dtype::Real<T>>> {
  AngleGradFunctor(const dtype::Real<T>* dout, const T* x, T* dx, int64_t numel)
      : dout_(dout), x_(x), dx_(dx), numel_(numel) {}

  HOSTDEVICE void operator()(int64_t idx) const { dx_[idx] = 0; }

  const dtype::Real<T>* dout_;
  const T* x_;
  T* dx_;
  int64_t numel_;
};

}  // namespace funcs
}  // namespace phi