boost/math
2
0
Fork 0
mirror of https://github.com/boostorg/math.git synced 2026-01-28 07:22:12 +00:00
Code Issues Projects Releases Wiki Activity

pFq: Change pnorm to p_abs_error.

Browse Source 
Update docs to reflect the fact that this is an error estimate.
This commit is contained in:
jzmaddock
2019-07-28 17:48:04 +01:00
parent b0d3662ab6
commit ae2caa30fd
2 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
include/boost/math/special_functions/hypergeometric_pFq.hpp
View File

@@ -8,8 +8,15 @@
#ifndef BOOST_MATH_HYPERGEOMETRIC_PFQ_HPP
#define BOOST_MATH_HYPERGEOMETRIC_PFQ_HPP
#include <boost/config.hpp>
#if defined(BOOST_NO_CXX11_AUTO_DECLARATIONS) || defined(BOOST_NO_CXX11_LAMBDAS) || defined(BOOST_NO_CXX11_UNIFIED_INITIALIZATION_SYNTAX) || defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST)
# error "hypergeometric_pFq requires a C++11 compiler"
#endif
#include <boost/math/special_functions/detail/hypergeometric_pFq_checked_series.hpp>
#include <boost/chrono.hpp>
#include <initializer_list>
namespace boost {
namespace math {
@@ -42,7 +49,7 @@ namespace boost {
}
template <class Seq, class Real, class Policy>
inline typename tools::promote_args<Real, typename Seq::value_type>::type hypergeometric_pFq(const Seq& aj, const Seq& bj, const Real& z, Real* pNorm, const Policy& pol)
inline typename tools::promote_args<Real, typename Seq::value_type>::type hypergeometric_pFq(const Seq& aj, const Seq& bj, const Real& z, Real* p_abs_error, const Policy& pol)
{
typedef typename tools::promote_args<Real, typename Seq::value_type>::type result_type;
typedef typename policies::evaluation<result_type, Policy>::type value_type;
@@ -59,27 +66,27 @@ namespace boost {
std::pair<value_type, value_type> r = boost::math::detail::hypergeometric_pFq_checked_series_impl(aj, bj, value_type(z), pol, boost::math::detail::iteration_terminator(boost::math::policies::get_max_series_iterations<forwarding_policy>()), scale);
r.first *= exp(Real(scale));
r.second *= exp(Real(scale));
if (pNorm)
*pNorm = static_cast<Real>(r.second);
if (p_abs_error)
*p_abs_error = static_cast<Real>(r.second) * boost::math::tools::epsilon<Real>();
return policies::checked_narrowing_cast<result_type, Policy>(r.first, "boost::math::hypergeometric_pFq<%1%>(%1%,%1%,%1%)");
}
template <class Seq, class Real>
inline typename tools::promote_args<Real, typename Seq::value_type>::type hypergeometric_pFq(const Seq& aj, const Seq& bj, const Real& z, Real* pNorm = 0)
inline typename tools::promote_args<Real, typename Seq::value_type>::type hypergeometric_pFq(const Seq& aj, const Seq& bj, const Real& z, Real* p_abs_error = 0)
{
return hypergeometric_pFq(aj, bj, z, pNorm, boost::math::policies::policy<>());
return hypergeometric_pFq(aj, bj, z, p_abs_error, boost::math::policies::policy<>());
}
template <class R, class Real, class Policy>
inline typename tools::promote_args<Real, R>::type hypergeometric_pFq(const std::initializer_list<R>& aj, const std::initializer_list<R>& bj, const Real& z, Real* pNorm, const Policy& pol)
inline typename tools::promote_args<Real, R>::type hypergeometric_pFq(const std::initializer_list<R>& aj, const std::initializer_list<R>& bj, const Real& z, Real* p_abs_error, const Policy& pol)
{
return hypergeometric_pFq<std::initializer_list<R>, Real, Policy>(aj, bj, z, pNorm, pol);
return hypergeometric_pFq<std::initializer_list<R>, Real, Policy>(aj, bj, z, p_abs_error, pol);
}
template <class R, class Real>
inline typename tools::promote_args<Real, R>::type hypergeometric_pFq(const std::initializer_list<R>& aj, const std::initializer_list<R>& bj, const Real& z, Real* pNorm = 0)
inline typename tools::promote_args<Real, R>::type hypergeometric_pFq(const std::initializer_list<R>& aj, const std::initializer_list<R>& bj, const Real& z, Real* p_abs_error = 0)
{
return hypergeometric_pFq<std::initializer_list<R>, Real>(aj, bj, z, pNorm);
return hypergeometric_pFq<std::initializer_list<R>, Real>(aj, bj, z, p_abs_error);
}
template <class T>