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