NumCpp  2.3.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
legendre_q.hpp
Go to the documentation of this file.
1 #pragma once
29 
32 #include "NumCpp/NdArray.hpp"
33 
34 #include "boost/math/special_functions/legendre.hpp"
35 
36 namespace nc
37 {
38  namespace polynomial
39  {
40  //============================================================================
41  // Method Description:
49  template<typename dtype>
50  double legendre_q(int32 n, dtype x)
51  {
53 
54  if (x < -1.0 || x > 1.0 )
55  {
56  THROW_INVALID_ARGUMENT_ERROR("input x must be of the range [-1, 1].");
57  }
58 
59  return boost::math::legendre_q(n, static_cast<double>(x));
60  }
61 
62  //============================================================================
63  // Method Description:
71  template<typename dtype>
73  {
74  NdArray<double> returnArray(inArrayX.shape());
75 
76  const auto function = [n](dtype x) -> double
77  {
78  return legendre_q(n, x);
79  };
80 
81  stl_algorithms::transform(inArrayX.cbegin(), inArrayX.cend(), returnArray.begin(), function);
82 
83  return returnArray;
84  }
85  } // namespace polynomial
86 } // namespace nc
StaticAsserts.hpp
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4311
nc::int32
std::int32_t int32
Definition: Types.hpp:36
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
nc::polynomial::legendre_q
NdArray< double > legendre_q(int32 n, const NdArray< dtype > &inArrayX)
Definition: legendre_q.hpp:72
nc::NdArray< double >
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
NdArray.hpp
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1490
nc
Definition: Coordinate.hpp:44
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1146
StlAlgorithms.hpp
nc::polynomial::legendre_q
double legendre_q(int32 n, dtype x)
Definition: legendre_q.hpp:50
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1090