stdComplex.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2025 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://scicomp.rptu.de
 * Contact:  Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
 *
 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
 *
 * CoDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * CoDiPack is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU General Public License for more details.
 * You should have received a copy of the GNU
 * General Public License along with CoDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * For other licensing options please contact us.
 *
 * Authors:
 *  - SciComp, University of Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include <complex>
 
#include "../../config.h"
#include "../../misc/macros.hpp"
#include "../../misc/self.hpp"
#include "../../traits/computationTraits.hpp"
#include "../activeType.hpp"
#include "../aggregate/aggregatedActiveType.hpp"
#include "../computeExpression.hpp"
#include "../expressionInterface.hpp"
#include "../expressionMemberOperations.hpp"
#include "../real/binaryOperators.hpp"
#include "../real/unaryOperators.hpp"
#include "allOperators.hpp"
#include "complexPredef.hpp"

namespace codi {
  template<typename T_Real, typename T_Impl>
  struct ExpressionMemberOperations<
      T_Real, T_Impl,
      typename std::enable_if<std::is_same<T_Real, std::complex<typename T_Real::value_type>>::value>::type> {
    public:
      using Real = CODI_DD(T_Real, std::complex<double>);                     
      using Impl = CODI_DD(T_Impl, CODI_T(ExpressionInterface<Real, void>));  
 
      using InnerType = typename Real::value_type;  

      using ExpressionComplexReal = ComputeExpression<InnerType, OperationComplexReal, Impl>;

      ExpressionComplexReal real() const {
        return ExpressionComplexReal(cast());
      }

      /// Expression returned by imag.
      using ExpressionComplexImag = ComputeExpression<InnerType, OperationComplexImag, Impl>;


      ExpressionComplexImag imag() const {
        return ExpressionComplexImag(cast());
      }
 
    private:
      CODI_INLINE Impl const& cast() const {
        return static_cast<Impl const&>(*this);
      }
  };

  template<typename T_InnerActive, typename T_Impl>
  struct ActiveComplex : public AggregatedActiveType<std::complex<typename T_InnerActive::Real>, T_InnerActive,
                                                     ResolveSelf<T_Impl, ActiveComplex<T_InnerActive, T_Impl>>>,
                         public AssignmentOperators<typename T_InnerActive::Real, false,
                                                    ResolveSelf<T_Impl, ActiveComplex<T_InnerActive, T_Impl>>>,
                         public AssignmentOperators<std::complex<typename T_InnerActive::Real>, false,
                                                    ResolveSelf<T_Impl, ActiveComplex<T_InnerActive, T_Impl>>> {
    public:
 
      using InnerActive = CODI_DD(T_InnerActive, CODI_DEFAULT_ACTIVE_TYPE);             
      using Impl = CODI_DD(CODI_T(ResolveSelf<T_Impl, ActiveComplex>), ActiveComplex);  
 
      using InnerReal = typename InnerActive::Real;                 
      using Real = std::complex<InnerReal>;                         
      using PassiveInnerReal = RealTraits::PassiveReal<InnerReal>;  
 
      using Base = AggregatedActiveType<Real, InnerActive, Impl>;  
      using AssignReal =
          AssignmentOperators<InnerReal, false, ResolveSelf<Impl, ActiveComplex>>;  
      using AssignComplex =
          AssignmentOperators<std::complex<InnerReal>, false, ResolveSelf<Impl, ActiveComplex>>;  
 
      using value_type = InnerActive;  
 
      using Base::Base;       
      using Base::operator=;  
 
      using AssignReal::operator+=;     
      using AssignComplex::operator+=;  
      using AssignReal::operator-=;     
      using AssignComplex::operator-=;  
      using AssignReal::operator*=;     
      using AssignComplex::operator*=;  
      using AssignReal::operator/=;     
      using AssignComplex::operator/=;  

      template<typename ArgR>
      CODI_INLINE ActiveComplex(ExpressionInterface<InnerReal, ArgR> const& argR) : Base() {
        Base::values[0] = argR.cast();
        Base::values[1] = PassiveInnerReal();
      }

      CODI_INLINE ActiveComplex(PassiveInnerReal const& argR) : Base() {
        Base::values[0] = argR;
        Base::values[1] = PassiveInnerReal();
      }

      template<typename ArgR, typename ArgI>
      CODI_INLINE ActiveComplex(ExpressionInterface<InnerReal, ArgR> const& argR,
                                ExpressionInterface<InnerReal, ArgI> const& argI)
          : Base() {
        Base::values[0] = argR.cast();
        Base::values[1] = argI.cast();
      }

      template<typename ArgI>
      CODI_INLINE ActiveComplex(PassiveInnerReal const& argR, ExpressionInterface<InnerReal, ArgI> const& argI)
          : Base() {
        Base::values[0] = argR;
        Base::values[1] = argI.cast();
      }

      template<typename ArgR>
      CODI_INLINE ActiveComplex(ExpressionInterface<InnerReal, ArgR> const& argR, PassiveInnerReal const& argI)
          : Base() {
        Base::values[0] = argR.cast();
        Base::values[1] = argI;
      }

      CODI_INLINE ActiveComplex(PassiveInnerReal const& argR, PassiveInnerReal const& argI) : Base() {
        Base::values[0] = argR;
        Base::values[1] = argI;
      }
 
      CODI_INLINE ~ActiveComplex() = default;  

      template<typename ArgR>
      CODI_INLINE ActiveComplex& operator=(ExpressionInterface<InnerReal, ArgR> const& argR) {
        Base::values[0] = argR.cast();
        Base::values[1] = PassiveInnerReal();
 
        return *this;
      }

      CODI_INLINE ActiveComplex& operator=(PassiveInnerReal const& argR) {
        Base::values[0] = argR;
        Base::values[1] = PassiveInnerReal();
 
        return *this;
      }
  };
 
  namespace RealTraits {

    template<typename T_InnerReal>
    struct AggregatedTypeTraits<std::complex<T_InnerReal>>
        : public ArrayAggregatedTypeTraitsBase<std::complex<T_InnerReal>, T_InnerReal,
                                               std::complex<RealTraits::Real<T_InnerReal>>, 2> {
      public:
        static CODI_INLINE std::string getMathRep() {
          return "complex()";
        }
    };

    template<typename T_InnerReal>
    struct AggregatedTypeTraits<ActiveComplex<T_InnerReal>>
        : public ArrayAggregatedTypeTraitsBase<
              ActiveComplex<T_InnerReal>, T_InnerReal,
              typename std::conditional<std::is_floating_point<RealTraits::Real<T_InnerReal>>::value,
                                        std::complex<RealTraits::Real<T_InnerReal>>,
                                        ActiveComplex<RealTraits::Real<T_InnerReal>>>::type,
              2> {
      public:
        static CODI_INLINE std::string getMathRep() {
          return "complex()";
        }
    };
  }

  template<typename T_InnerReal, typename T_Tape>
  struct ExpressionTraits::ActiveResultImpl<std::complex<T_InnerReal>, T_Tape, false> {
      using InnerReal = CODI_DD(T_InnerReal, CODI_ANY);  
      using Tape = CODI_DD(T_Tape, CODI_ANY);            

      using InnerActiveResult = ExpressionTraits::ActiveResult<InnerReal, Tape, false>;

#if CODI_SpecializeStdComplex
      using ActiveResult = std::complex<InnerActiveResult>;
#else
      using ActiveResult = ActiveComplex<InnerActiveResult>;
#endif
  };
}
 
#if CODI_SpecializeStdComplex
namespace std {
 
  /*******************************************************************************/

  template<typename T_Tape>
  class complex<codi::ActiveType<T_Tape>>
      : public codi::ActiveComplex<codi::ActiveType<T_Tape>, complex<codi::ActiveType<T_Tape>>> {
    public:

      using Tape = CODI_DD(T_Tape, CODI_T(codi::FullTapeInterface<double, double, int, codi::EmptyPosition>));
 
      using Real = complex<typename Tape::Real>;     
      using InnerActive = codi::ActiveType<Tape>;    
      using InnerReal = typename InnerActive::Real;  

      using Base = codi::ActiveComplex<codi::ActiveType<Tape>, complex<codi::ActiveType<T_Tape>>>;
 
      using Base::Base;                                           
      CODI_INLINE complex(complex const& value) : Base(value) {}  
 
      CODI_INLINE ~complex() = default;  
 
      using Base::operator=;  

      CODI_INLINE complex& operator=(complex const& value) {
        Base::store(value, codi::EventHints::Statement::Copy);
 
        return *this;
      }
  };

  template<typename Tape>
  CODI_INLINE std::ostream& operator<<(std::ostream& out, std::complex<codi::ActiveType<Tape>> const& v) {
    out << v.getValue();
 
    return out;
  }

  /*******************************************************************************/
 
  #define FUNCTION operator+
  #define OPERATION_LOGIC codi::OperationAdd
  #include "binaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION operator-
  #define OPERATION_LOGIC codi::OperationSubstract
  #include "binaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION operator*
  #define OPERATION_LOGIC codi::OperationMultiply
  #include "binaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION operator/
  #define OPERATION_LOGIC codi::OperationDivide
  #include "binaryComplexToComplexStdSpecialization.tpp"
 
  // polar needs to be created in the codi namespace.
 
  #define FUNCTION pow
  #define OPERATION_LOGIC codi::OperationPow
  #include "binaryComplexToComplexStdSpecialization.tpp"

  /*******************************************************************************/

  template<typename Tape>
  CODI_INLINE complex<codi::ActiveType<Tape>> const& operator+(complex<codi::ActiveType<Tape>> const& arg) {
    return arg;
  }
 
  #define FUNCTION operator-
  #define OPERATION_LOGIC codi::OperationUnaryMinus
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION abs
  #define OPERATION_LOGIC codi::OperationComplexAbs
  #include "unaryComplexToRealStdSpecialization.tpp"
 
  #define FUNCTION acos
  #define OPERATION_LOGIC codi::OperationAcos
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION acosh
  #define OPERATION_LOGIC codi::OperationAcosh
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION arg
  #define OPERATION_LOGIC codi::OperationComplexArg
  #include "unaryComplexToRealStdSpecialization.tpp"
 
  #define FUNCTION asin
  #define OPERATION_LOGIC codi::OperationAsin
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION asinh
  #define OPERATION_LOGIC codi::OperationAsinh
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION atan
  #define OPERATION_LOGIC codi::OperationAtan
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION atanh
  #define OPERATION_LOGIC codi::OperationAtanh
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION conj
  #define OPERATION_LOGIC codi::OperationComplexConj
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION cos
  #define OPERATION_LOGIC codi::OperationCos
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION cosh
  #define OPERATION_LOGIC codi::OperationCosh
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION exp
  #define OPERATION_LOGIC codi::OperationExp
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION imag
  #define OPERATION_LOGIC codi::OperationComplexImag
  #include "unaryComplexToRealStdSpecialization.tpp"
 
  #define FUNCTION log
  #define OPERATION_LOGIC codi::OperationLog
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION log10
  #define OPERATION_LOGIC codi::OperationLog10
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION norm
  #define OPERATION_LOGIC codi::OperationComplexNorm
  #include "unaryComplexToRealStdSpecialization.tpp"
 
  #define FUNCTION proj
  #define OPERATION_LOGIC codi::OperationComplexProj
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION real
  #define OPERATION_LOGIC codi::OperationComplexReal
  #include "unaryComplexToRealStdSpecialization.tpp"
 
  #define FUNCTION sin
  #define OPERATION_LOGIC codi::OperationSin
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION sinh
  #define OPERATION_LOGIC codi::OperationSinh
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION sqrt
  #define OPERATION_LOGIC codi::OperationSqrt
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION tan
  #define OPERATION_LOGIC codi::OperationTan
  #include "unaryComplexToComplexStdSpecialization.tpp"
 
  #define FUNCTION tanh
  #define OPERATION_LOGIC codi::OperationTanh
  #include "unaryComplexToComplexStdSpecialization.tpp"

}
#endif