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

constexpr fmod (#699)

Browse Source 
* constexpr fmod

* Fix for old clang versions
This commit is contained in:
Matt Borland
2021-10-02 18:07:14 +03:00
committed by GitHub
parent 85676085ea
commit 6d5aeb08ea
6 changed files with 213 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/sf/ccmath.qbk
View File

@@ -123,6 +123,13 @@ All of the following functions require C++17 or greater.
template <typename T>
inline constexpr long long llround(T arg)
template <typename Real>
inline constexpr Real fmod(Real x, Real y) noexcept
template <typename Arithmetic1, typename Arithmetic2>
inline constexpr Promoted fmod(Arithmetic1 x, Arithmetic2 y) noexcept
The Promoted return type will have at least double prescision, but be up to the highest precision argument.
} // Namespaces

1
include/boost/math/ccmath/ccmath.hpp
View File

@@ -26,5 +26,6 @@
#include <boost/math/ccmath/trunc.hpp>
#include <boost/math/ccmath/modf.hpp>
#include <boost/math/ccmath/round.hpp>
#include <boost/math/ccmath/fmod.hpp>
#endif // BOOST_MATH_CCMATH_HPP

109
include/boost/math/ccmath/fmod.hpp Normal file
View File

@@ -0,0 +1,109 @@
// (C) Copyright Matt Borland 2021.
// Use, modification and distribution are subject to the
// Boost Software License, Version 1.0. (See accompanying file
// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#ifndef BOOST_MATH_CCMATH_FMOD_HPP
#define BOOST_MATH_CCMATH_FMOD_HPP
#include <cmath>
#include <cstdint>
#include <limits>
#include <type_traits>
#include <boost/math/tools/is_constant_evaluated.hpp>
#include <boost/math/ccmath/abs.hpp>
#include <boost/math/ccmath/isinf.hpp>
#include <boost/math/ccmath/isnan.hpp>
#include <boost/math/ccmath/isfinite.hpp>
namespace boost::math::ccmath {
namespace detail {
template <typename ReturnType, typename T1, typename T2>
inline constexpr ReturnType fmod_impl(T1 x, T2 y) noexcept
{
if(x == y)
{
return ReturnType(0);
}
else
{
while(x >= y)
{
x -= y;
}
return static_cast<ReturnType>(x);
}
}
} // Namespace detail
template <typename Real, std::enable_if_t<!std::is_integral_v<Real>, bool> = true>
inline constexpr Real fmod(Real x, Real y) noexcept
{
if(BOOST_MATH_IS_CONSTANT_EVALUATED(x))
{
return boost::math::ccmath::abs(x) == Real(0) && y != Real(0) ? x :
boost::math::ccmath::isinf(x) && !boost::math::ccmath::isnan(y) ? std::numeric_limits<Real>::quiet_NaN() :
boost::math::ccmath::abs(y) == Real(0) && !boost::math::ccmath::isnan(x) ? std::numeric_limits<Real>::quiet_NaN() :
boost::math::ccmath::isinf(y) && boost::math::ccmath::isfinite(x) ? x :
boost::math::ccmath::isnan(x) ? std::numeric_limits<Real>::quiet_NaN() :
boost::math::ccmath::isnan(y) ? std::numeric_limits<Real>::quiet_NaN() :
boost::math::ccmath::detail::fmod_impl<Real>(x, y);
}
else
{
using std::fmod;
return fmod(x, y);
}
}
template <typename T1, typename T2>
inline constexpr auto fmod(T1 x, T2 y) noexcept
{
if(BOOST_MATH_IS_CONSTANT_EVALUATED(x))
{
// If the type is an integer (e.g. epsilon == 0) then set the epsilon value to 1 so that type is at a minimum
// cast to double
constexpr auto T1p = std::numeric_limits<T1>::epsilon() > 0 ? std::numeric_limits<T1>::epsilon() : 1;
constexpr auto T2p = std::numeric_limits<T2>::epsilon() > 0 ? std::numeric_limits<T2>::epsilon() : 1;
using promoted_type =
#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
std::conditional_t<T1p <= LDBL_EPSILON && T1p <= T2p, T1,
std::conditional_t<T2p <= LDBL_EPSILON && T2p <= T1p, T2,
#endif
std::conditional_t<T1p <= DBL_EPSILON && T1p <= T2p, T1,
std::conditional_t<T2p <= DBL_EPSILON && T2p <= T1p, T2, double
#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
>>>>;
#else
>>;
#endif
return boost::math::ccmath::fmod(promoted_type(x), promoted_type(y));
}
else
{
using std::fmod;
return fmod(x, y);
}
}
inline constexpr float fmodf(float x, float y) noexcept
{
return boost::math::ccmath::fmod(x, y);
}
#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
inline constexpr long double fmodl(long double x, long double y) noexcept
{
return boost::math::ccmath::fmod(x, y);
}
#endif
} // Namespaces
#endif // BOOST_MATH_CCMATH_FMOD_HPP

1
test/Jamfile.v2
View File

@@ -140,6 +140,7 @@ test-suite special_fun :
[ run ccmath_trunc_test.cpp ../../test/build//boost_unit_test_framework : : : [ requires cxx17_if_constexpr ] ]
[ run ccmath_modf_test.cpp ../../test/build//boost_unit_test_framework : : : [ requires cxx17_if_constexpr ] ]
[ run ccmath_round_test.cpp ../../test/build//boost_unit_test_framework : : : [ requires cxx17_if_constexpr ] ]
[ run ccmath_fmod_test.cpp ../../test/build//boost_unit_test_framework : : : [ requires cxx17_if_constexpr ] ]
[ run log1p_expm1_test.cpp test_instances//test_instances pch_light ../../test/build//boost_unit_test_framework ]
[ run powm1_sqrtp1m1_test.cpp test_instances//test_instances pch_light ../../test/build//boost_unit_test_framework ]
[ run special_functions_test.cpp ../../test/build//boost_unit_test_framework ]

79
test/ccmath_fmod_test.cpp Normal file
View File

@@ -0,0 +1,79 @@
// (C) Copyright Matt Borland 2021.
// Use, modification and distribution are subject to the
// Boost Software License, Version 1.0. (See accompanying file
// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <cmath>
#include <cfloat>
#include <cstdint>
#include <limits>
#include <type_traits>
#include <boost/math/tools/is_constant_evaluated.hpp>
#include <boost/math/ccmath/fmod.hpp>
#include <boost/math/ccmath/isnan.hpp>
#include <boost/math/ccmath/isinf.hpp>
#ifdef BOOST_HAS_FLOAT128
#include <boost/multiprecision/float128.hpp>
#endif
#if !defined(BOOST_MATH_NO_CONSTEXPR_DETECTION) && !defined(BOOST_MATH_USING_BUILTIN_CONSTANT_P)
template <typename T>
constexpr void test()
{
// Error Handling
if constexpr (std::numeric_limits<T>::has_quiet_NaN)
{
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(std::numeric_limits<T>::quiet_NaN(), T(1))), "If x is NaN, NaN is returned");
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(T(1), std::numeric_limits<T>::quiet_NaN())), "If y is NaN, NaN is returned");
}
static_assert(boost::math::ccmath::fmod(T(0), T(1.0)) == 0);
static_assert(boost::math::ccmath::fmod(T(-0), T(1.0)) == -0);
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(std::numeric_limits<T>::infinity(), T(1.0))));
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(-std::numeric_limits<T>::infinity(), T(1.0))));
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(T(1), T(0))));
static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(T(1), T(-0))));
static_assert(boost::math::ccmath::fmod(T(1), std::numeric_limits<T>::infinity()) == T(1));
static_assert(boost::math::ccmath::fmod(T(1), -std::numeric_limits<T>::infinity()) == T(1));
// Functionality
static_assert(boost::math::ccmath::fmod(T(3.0/2), T(1.0) == T(3.0/2)));
static_assert(boost::math::ccmath::fmod(T(7.0/3), T(2.0) == T(1.0/3)));
static_assert(boost::math::ccmath::fmod(T(-8.0/3), T(2.0) == T(-2.0/3)));
// Correct promoted types
if constexpr (!std::is_same_v<T, float>)
{
constexpr auto test_type = boost::math::ccmath::fmod(T(1), 1.0f);
static_assert(std::is_same_v<T, std::remove_cv_t<decltype(test_type)>>);
}
else
{
constexpr auto test_type = boost::math::ccmath::fmod(1.0f, 1);
static_assert(std::is_same_v<double, std::remove_cv_t<decltype(test_type)>>);
}
}
int main()
{
test<float>();
test<double>();
#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
test<long double>();
#endif
#ifdef BOOST_HAS_FLOAT128
test<boost::multiprecision::float128>();
#endif
return 0;
}
#else
int main()
{
return 0;
}
#endif

16
test/compile_test/ccmath_fmod_incl_test.cpp Normal file
View File

@@ -0,0 +1,16 @@
// (C) Copyright Matt Borland 2021.
// Use, modification and distribution are subject to the
// Boost Software License, Version 1.0. (See accompanying file
// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/math/ccmath/fmod.hpp>
#include "test_compile_result.hpp"
void compile_and_link_test()
{
check_result<float>(boost::math::ccmath::fmod(1.0f, 1.0f));
check_result<double>(boost::math::ccmath::fmod(1.0, 1.0));
#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS
check_result<long double>(boost::math::ccmath::fmod(1.0l, 1.0l));
#endif
}