NumCpp  2.8.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 
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
39 {
40  namespace polynomial
41  {
42  //============================================================================
43  // Method Description:
51  template<typename dtype>
52  double legendre_q(int32 n, dtype x)
53  {
55 
56  if (x < -1.0 || x > 1.0)
57  {
58  THROW_INVALID_ARGUMENT_ERROR("input x must be of the range [-1, 1].");
59  }
60 
61  return boost::math::legendre_q(n, static_cast<double>(x));
62  }
63 
64  //============================================================================
65  // Method Description:
73  template<typename dtype>
75  {
76  NdArray<double> returnArray(inArrayX.shape());
77 
78  const auto function = [n](dtype x) -> double { return legendre_q(n, x); };
79 
80  stl_algorithms::transform(inArrayX.cbegin(), inArrayX.cend(), returnArray.begin(), function);
81 
82  return returnArray;
83  }
84  } // namespace polynomial
85 } // namespace nc
86 
87 #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
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1221
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4276
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1529
iterator begin() noexcept
Definition: NdArrayCore.hpp:1171
double legendre_q(int32 n, dtype x)
Definition: legendre_q.hpp:52
NdArray< double > legendre_q(int32 n, const NdArray< dtype > &inArrayX)
Definition: legendre_q.hpp:74
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:784
Definition: Coordinate.hpp:45
std::int32_t int32
Definition: Types.hpp:36