diff --git a/doc/sf/ccmath.qbk b/doc/sf/ccmath.qbk index db379d91d5..4f19f919ad 100644 --- a/doc/sf/ccmath.qbk +++ b/doc/sf/ccmath.qbk @@ -123,6 +123,13 @@ All of the following functions require C++17 or greater. template inline constexpr long long llround(T arg) + + template + inline constexpr Real fmod(Real x, Real y) noexcept + + template + 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 diff --git a/include/boost/math/ccmath/ccmath.hpp b/include/boost/math/ccmath/ccmath.hpp index 8269a198de..de7d1d9fa5 100644 --- a/include/boost/math/ccmath/ccmath.hpp +++ b/include/boost/math/ccmath/ccmath.hpp @@ -26,5 +26,6 @@ #include #include #include +#include #endif // BOOST_MATH_CCMATH_HPP diff --git a/include/boost/math/ccmath/fmod.hpp b/include/boost/math/ccmath/fmod.hpp new file mode 100644 index 0000000000..12e67d8c06 --- /dev/null +++ b/include/boost/math/ccmath/fmod.hpp @@ -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 +#include +#include +#include +#include +#include +#include +#include +#include + +namespace boost::math::ccmath { + +namespace detail { + +template +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(x); + } +} + +} // Namespace detail + +template , 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::quiet_NaN() : + boost::math::ccmath::abs(y) == Real(0) && !boost::math::ccmath::isnan(x) ? std::numeric_limits::quiet_NaN() : + boost::math::ccmath::isinf(y) && boost::math::ccmath::isfinite(x) ? x : + boost::math::ccmath::isnan(x) ? std::numeric_limits::quiet_NaN() : + boost::math::ccmath::isnan(y) ? std::numeric_limits::quiet_NaN() : + boost::math::ccmath::detail::fmod_impl(x, y); + } + else + { + using std::fmod; + return fmod(x, y); + } +} + +template +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::epsilon() > 0 ? std::numeric_limits::epsilon() : 1; + constexpr auto T2p = std::numeric_limits::epsilon() > 0 ? std::numeric_limits::epsilon() : 1; + + using promoted_type = + #ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS + std::conditional_t>>>; + #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 diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index e8b5aa6d1e..cc2f4ebada 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -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 ] diff --git a/test/ccmath_fmod_test.cpp b/test/ccmath_fmod_test.cpp new file mode 100644 index 0000000000..83f9e50532 --- /dev/null +++ b/test/ccmath_fmod_test.cpp @@ -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 +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef BOOST_HAS_FLOAT128 +#include +#endif + +#if !defined(BOOST_MATH_NO_CONSTEXPR_DETECTION) && !defined(BOOST_MATH_USING_BUILTIN_CONSTANT_P) +template +constexpr void test() +{ + // Error Handling + if constexpr (std::numeric_limits::has_quiet_NaN) + { + static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(std::numeric_limits::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::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::infinity(), T(1.0)))); + static_assert(boost::math::ccmath::isnan(boost::math::ccmath::fmod(-std::numeric_limits::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::infinity()) == T(1)); + static_assert(boost::math::ccmath::fmod(T(1), -std::numeric_limits::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) + { + constexpr auto test_type = boost::math::ccmath::fmod(T(1), 1.0f); + static_assert(std::is_same_v>); + } + else + { + constexpr auto test_type = boost::math::ccmath::fmod(1.0f, 1); + static_assert(std::is_same_v>); + } +} + +int main() +{ + test(); + test(); + + #ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS + test(); + #endif + + #ifdef BOOST_HAS_FLOAT128 + test(); + #endif + + return 0; +} +#else +int main() +{ + return 0; +} +#endif diff --git a/test/compile_test/ccmath_fmod_incl_test.cpp b/test/compile_test/ccmath_fmod_incl_test.cpp new file mode 100644 index 0000000000..65925c8918 --- /dev/null +++ b/test/compile_test/ccmath_fmod_incl_test.cpp @@ -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 +#include "test_compile_result.hpp" + +void compile_and_link_test() +{ + check_result(boost::math::ccmath::fmod(1.0f, 1.0f)); + check_result(boost::math::ccmath::fmod(1.0, 1.0)); +#ifndef BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS + check_result(boost::math::ccmath::fmod(1.0l, 1.0l)); +#endif +}