NumCpp  2.6.2
A Templatized Header Only C++ Implementation of the Python NumPy Library
legendre_q.hpp
Go to the documentation of this file.
1 
28 #pragma once
29 
30 #ifndef NUMCPP_NO_USE_BOOST
31 
34 #include "NumCpp/NdArray.hpp"
35 
36 #include "boost/math/special_functions/legendre.hpp"
37 
38 namespace nc
39 {
40  namespace polynomial
41  {
42  //============================================================================
43  // Method Description:
52  template<typename dtype>
53  double legendre_q(int32 n, dtype x)
54  {
56 
57  if (x < -1.0 || x > 1.0 )
58  {
59  THROW_INVALID_ARGUMENT_ERROR("input x must be of the range [-1, 1].");
60  }
61 
62  return boost::math::legendre_q(n, static_cast<double>(x));
63  }
64 
65  //============================================================================
66  // Method Description:
75  template<typename dtype>
77  {
78  NdArray<double> returnArray(inArrayX.shape());
79 
80  const auto function = [n](dtype x) -> double
81  {
82  return legendre_q(n, x);
83  };
84 
85  stl_algorithms::transform(inArrayX.cbegin(), inArrayX.cend(), returnArray.begin(), function);
86 
87  return returnArray;
88  }
89  } // namespace polynomial
90 } // namespace nc
91 
92 #endif // #ifndef NUMCPP_NO_USE_BOOST
#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
double legendre_q(int32 n, dtype x)
Definition: legendre_q.hpp:53
NdArray< double > legendre_q(int32 n, const NdArray< dtype > &inArrayX)
Definition: legendre_q.hpp:76
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
Definition: Coordinate.hpp:45
std::int32_t int32
Definition: Types.hpp:36