complex.hpp

Go to the documentation of this file.

#pragma once
 
#include <complex>
 
#include "NumCpp/Core/Internal/Error.hpp"
#include "NumCpp/Core/Internal/StaticAsserts.hpp"
#include "NumCpp/Core/Internal/StlAlgorithms.hpp"
#include "NumCpp/NdArray.hpp"
 
namespace nc
{
    //============================================================================
    // Method Description:
    template<typename dtype, typename dtypeOut = dtype>
    auto complex(dtype inReal)
    {
        STATIC_ASSERT_ARITHMETIC(dtype);
        STATIC_ASSERT_ARITHMETIC(dtypeOut);
 
        return std::complex<dtypeOut>(inReal);
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, typename dtypeOut = dtype>
    auto complex(dtype inReal, dtype inImag)
    {
        STATIC_ASSERT_ARITHMETIC(dtype);
        STATIC_ASSERT_ARITHMETIC(dtypeOut);
 
        return std::complex<dtypeOut>(inReal, inImag);
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, typename dtypeOut = dtype, std::enable_if_t<std::is_arithmetic_v<dtype>, int> = 0>
    auto complex(const NdArray<dtype>& inReal)
    {
        NdArray<decltype(nc::complex(dtypeOut{ 0 }))> returnArray(inReal.shape());
        stl_algorithms::transform(inReal.cbegin(),
                                  inReal.cend(),
                                  returnArray.begin(),
                                  [](dtype real) -> auto { return nc::complex<dtype, dtypeOut>(real); });
 
        return returnArray;
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, typename dtypeOut = dtype>
    auto complex(const NdArray<dtype>& inReal, const NdArray<dtype>& inImag)
    {
        if (inReal.shape() != inImag.shape())
        {
            THROW_INVALID_ARGUMENT_ERROR("Input real array must be the same shape as input imag array");
        }
 
        NdArray<decltype(nc::complex(dtypeOut{ 0 }, dtypeOut{ 0 }))> returnArray(inReal.shape());
        stl_algorithms::transform(inReal.cbegin(),
                                  inReal.cend(),
                                  inImag.cbegin(),
                                  returnArray.begin(),
                                  [](dtype real, dtype imag) -> auto
                                  { return nc::complex<dtype, dtypeOut>(real, imag); });
 
        return returnArray;
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, typename dtypeOut = dtype>
    auto complex(const NdArray<std::complex<dtype>>& inArray)
    {
        STATIC_ASSERT_ARITHMETIC(dtype);
        STATIC_ASSERT_ARITHMETIC(dtypeOut);
 
        return inArray.template astype<std::complex<dtypeOut>>();
    }
} // namespace nc