NumCpp  2.11.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
polar.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #include <complex>
31 
35 #include "NumCpp/NdArray.hpp"
36 
37 namespace nc
38 {
39  //============================================================================
40  // Method Description:
48  template<typename dtype>
49  auto polar(dtype magnitude, dtype phaseAngle)
50  {
52 
53  return std::polar(magnitude, phaseAngle);
54  }
55 
56  //============================================================================
57  // Method Description:
64  template<typename dtype>
65  auto polar(const NdArray<dtype>& magnitude, const NdArray<dtype>& phaseAngle)
66  {
67  if (magnitude.shape() != phaseAngle.shape())
68  {
69  THROW_INVALID_ARGUMENT_ERROR("Input magnitude and phaseAngle arrays must be the same shape");
70  }
71 
72  NdArray<decltype(nc::polar(dtype{ 0 }, dtype{ 0 }))> returnArray(magnitude.shape());
74  magnitude.cbegin(),
75  magnitude.cend(),
76  phaseAngle.begin(),
77  returnArray.begin(),
78  [](dtype mag, dtype angle) -> auto{ return nc::polar(mag, angle); });
79 
80  return returnArray;
81  }
82 } // namespace nc
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:37
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:39
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:138
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1318
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1626
iterator begin() noexcept
Definition: NdArrayCore.hpp:1268
const Shape & shape() const noexcept
Definition: NdArrayCore.hpp:4464
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:775
Definition: Cartesian.hpp:40
auto polar(const NdArray< dtype > &magnitude, const NdArray< dtype > &phaseAngle)
Definition: polar.hpp:65
auto angle(const std::complex< dtype > &inValue)
Definition: angle.hpp:48
auto polar(dtype magnitude, dtype phaseAngle)
Definition: polar.hpp:49