NumCpp  2.10.1
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 
30 #ifndef NUMCPP_NO_USE_BOOST
31 
32 #include "boost/math/special_functions/legendre.hpp"
33 
36 #include "NumCpp/NdArray.hpp"
37 
38 namespace nc::polynomial
39 {
40  //============================================================================
41  // Method Description:
49  template<typename dtype>
50  double legendre_q(int32 n, dtype x)
51  {
53 
54  if (x < -1. || x > 1.)
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 { return legendre_q(n, x); };
77 
78  stl_algorithms::transform(inArrayX.cbegin(), inArrayX.cend(), returnArray.begin(), function);
79 
80  return returnArray;
81  }
82 } // namespace nc::polynomial
83 
84 #endif // #ifndef NUMCPP_NO_USE_BOOST
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:37
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:39
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1308
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4402
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1616
iterator begin() noexcept
Definition: NdArrayCore.hpp:1258
Definition: chebyshev_t.hpp:39
double legendre_q(int32 n, dtype x)
Definition: legendre_q.hpp:50
NdArray< double > legendre_q(int32 n, const NdArray< dtype > &inArrayX)
Definition: legendre_q.hpp:72
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:775
std::int32_t int32
Definition: Types.hpp:36