// (C) Copyright Jeremy William Murphy 2016. // 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_INTEGER_COMMON_FACTOR_RT_HPP #define BOOST_INTEGER_COMMON_FACTOR_RT_HPP #include #include #include // for BOOST_NESTED_TEMPLATE, etc. #include // for std::numeric_limits #include // for CHAR_MIN #include #include #include #include #ifndef BOOST_NO_CXX11_HDR_TYPE_TRAITS #include #endif #ifdef BOOST_NO_CXX11_HDR_FUNCTIONAL #include #endif #if ((defined(BOOST_MSVC) && (BOOST_MSVC >= 1600)) || (defined(__clang__) && defined(__c2__)) || (defined(BOOST_INTEL) && defined(_MSC_VER))) && (defined(_M_IX86) || defined(_M_X64)) #include #endif #ifdef BOOST_MSVC #pragma warning(push) #pragma warning(disable:4127 4244) // Conditional expression is constant #endif #if !defined(BOOST_NO_CXX11_HDR_TYPE_TRAITS) && !defined(BOOST_NO_CXX11_NOEXCEPT) #define BOOST_GCD_NOEXCEPT(T) noexcept(std::is_arithmetic::value) #else #define BOOST_GCD_NOEXCEPT(T) #endif namespace boost { template class rational; namespace integer { namespace gcd_detail{ // // some helper functions which really should be constexpr already, but sadly aren't: // #ifndef BOOST_NO_CXX14_CONSTEXPR template inline constexpr T constexpr_min(T const& a, T const& b) BOOST_GCD_NOEXCEPT(T) { return a < b ? a : b; } template inline constexpr auto constexpr_swap(T&a, T& b) BOOST_GCD_NOEXCEPT(T) -> decltype(a.swap(b)) { return a.swap(b); } template inline constexpr void constexpr_swap(T&a, U& b...) BOOST_GCD_NOEXCEPT(T) { T t(static_cast(a)); a = static_cast(b); b = static_cast(t); } #else template inline T constexpr_min(T const& a, T const& b) BOOST_GCD_NOEXCEPT(T) { return a < b ? a : b; } template inline void constexpr_swap(T&a, T& b) BOOST_GCD_NOEXCEPT(T) { using std::swap; swap(a, b); } #endif template ::value || #endif (std::numeric_limits::is_specialized && !std::numeric_limits::is_signed)> struct gcd_traits_abs_defaults { inline static BOOST_CXX14_CONSTEXPR const T& abs(const T& val) BOOST_GCD_NOEXCEPT(T) { return val; } }; template struct gcd_traits_abs_defaults { inline static T BOOST_CXX14_CONSTEXPR abs(const T& val) BOOST_GCD_NOEXCEPT(T) { // This sucks, but std::abs is not constexpr :( return val < T(0) ? -val : val; } }; enum method_type { method_euclid = 0, method_binary = 1, method_mixed = 2 }; struct any_convert { template any_convert(const T&); }; struct unlikely_size { char buf[9973]; }; unlikely_size operator <<= (any_convert, any_convert); unlikely_size operator >>= (any_convert, any_convert); template struct gcd_traits_defaults : public gcd_traits_abs_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(T& val) BOOST_GCD_NOEXCEPT(T) { unsigned r = 0; while(0 == (val & 1u)) { #ifdef _MSC_VER // VC++ can't handle operator >>= in constexpr code for some reason val = val >> 1; #else val >>= 1; #endif ++r; } return r; } inline static BOOST_CXX14_CONSTEXPR bool less(const T& a, const T& b) BOOST_GCD_NOEXCEPT(T) { return a < b; } static T& get_value(); #ifndef BOOST_NO_SFINAE static const bool has_operator_left_shift_equal = sizeof(get_value() <<= 2) != sizeof(unlikely_size); static const bool has_operator_right_shift_equal = sizeof(get_value() >>= 2) != sizeof(unlikely_size); #else static const bool has_operator_left_shift_equal = true; static const bool has_operator_right_shift_equal = true; #endif static const method_type method = std::numeric_limits::is_specialized && std::numeric_limits::is_integer && has_operator_left_shift_equal && has_operator_right_shift_equal ? method_mixed : method_euclid; }; // // Default gcd_traits just inherits from defaults: // template struct gcd_traits : public gcd_traits_defaults {}; // // Some platforms have fast bitscan operations, that allow us to implement // make_odd much more efficiently, unfortunately we can't use these if we want // the functions to be constexpr as the compiler intrinsics aren't constexpr. // #if defined(BOOST_NO_CXX14_CONSTEXPR) && ((defined(BOOST_MSVC) && (BOOST_MSVC >= 1600)) || (defined(__clang__) && defined(__c2__)) || (defined(BOOST_INTEL) && defined(_MSC_VER))) && (defined(_M_IX86) || defined(_M_X64)) #pragma intrinsic(_BitScanForward,) template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned find_lsb(unsigned long val) BOOST_NOEXCEPT { unsigned long result; _BitScanForward(&result, val); return result; } BOOST_FORCEINLINE static unsigned make_odd(unsigned long& val) BOOST_NOEXCEPT { unsigned result = find_lsb(val); val >>= result; return result; } }; #ifdef _M_X64 #pragma intrinsic(_BitScanForward64) template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned find_lsb(unsigned __int64 mask) BOOST_NOEXCEPT { unsigned long result; _BitScanForward64(&result, mask); return result; } BOOST_FORCEINLINE static unsigned make_odd(unsigned __int64& val) BOOST_NOEXCEPT { unsigned result = find_lsb(val); val >>= result; return result; } }; #endif // // Other integer type are trivial adaptations of the above, // this works for signed types too, as by the time these functions // are called, all values are > 0. // template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(long& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(unsigned int& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(int& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(unsigned short& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(short& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(unsigned char& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(signed char& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(char& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; #ifndef BOOST_NO_INTRINSIC_WCHAR_T template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static unsigned make_odd(wchar_t& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; #endif #ifdef _M_X64 template <> struct gcd_traits<__int64> : public gcd_traits_defaults<__int64> { BOOST_FORCEINLINE static unsigned make_odd(__int64& val)BOOST_NOEXCEPT{ unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; #endif #elif defined(BOOST_GCC) || defined(__clang__) || (defined(BOOST_INTEL) && defined(__GNUC__)) template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned find_lsb(unsigned mask)BOOST_NOEXCEPT { return __builtin_ctz(mask); } BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(unsigned& val)BOOST_NOEXCEPT { unsigned result = find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned find_lsb(unsigned long mask)BOOST_NOEXCEPT { return __builtin_ctzl(mask); } BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(unsigned long& val)BOOST_NOEXCEPT { unsigned result = find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned find_lsb(boost::ulong_long_type mask)BOOST_NOEXCEPT { return __builtin_ctzll(mask); } BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(boost::ulong_long_type& val)BOOST_NOEXCEPT { unsigned result = find_lsb(val); val >>= result; return result; } }; // // Other integer type are trivial adaptations of the above, // this works for signed types too, as by the time these functions // are called, all values are > 0. // template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(boost::long_long_type& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(long& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(int& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(unsigned short& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(short& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(unsigned char& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(signed char& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(char& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; #ifndef BOOST_NO_INTRINSIC_WCHAR_T template <> struct gcd_traits : public gcd_traits_defaults { BOOST_FORCEINLINE static BOOST_CXX14_CONSTEXPR unsigned make_odd(wchar_t& val)BOOST_NOEXCEPT { unsigned result = gcd_traits::find_lsb(val); val >>= result; return result; } }; #endif #endif // // The Mixed Binary Euclid Algorithm // Sidi Mohamed Sedjelmaci // Electronic Notes in Discrete Mathematics 35 (2009) 169-176 // template BOOST_CXX14_CONSTEXPR T mixed_binary_gcd(T u, T v) BOOST_GCD_NOEXCEPT(T) { if(gcd_traits::less(u, v)) constexpr_swap(u, v); unsigned shifts = 0; if(u == T(0)) return v; if(v == T(0)) return u; shifts = constexpr_min(gcd_traits::make_odd(u), gcd_traits::make_odd(v)); while(gcd_traits::less(1, v)) { u %= v; v -= u; if(u == T(0)) return v << shifts; if(v == T(0)) return u << shifts; gcd_traits::make_odd(u); gcd_traits::make_odd(v); if(gcd_traits::less(u, v)) constexpr_swap(u, v); } return (v == 1 ? v : u) << shifts; } /** Stein gcd (aka 'binary gcd') * * From Mathematics to Generic Programming, Alexander Stepanov, Daniel Rose */ template BOOST_CXX14_CONSTEXPR SteinDomain Stein_gcd(SteinDomain m, SteinDomain n) BOOST_GCD_NOEXCEPT(SteinDomain) { BOOST_ASSERT(m >= 0); BOOST_ASSERT(n >= 0); if (m == SteinDomain(0)) return n; if (n == SteinDomain(0)) return m; // m > 0 && n > 0 unsigned d_m = gcd_traits::make_odd(m); unsigned d_n = gcd_traits::make_odd(n); // odd(m) && odd(n) while (m != n) { if (n > m) constexpr_swap(n, m); m -= n; gcd_traits::make_odd(m); } // m == n m <<= constexpr_min(d_m, d_n); return m; } /** Euclidean algorithm * * From Mathematics to Generic Programming, Alexander Stepanov, Daniel Rose * */ template inline BOOST_CXX14_CONSTEXPR EuclideanDomain Euclid_gcd(EuclideanDomain a, EuclideanDomain b) BOOST_GCD_NOEXCEPT(EuclideanDomain) { while (b != EuclideanDomain(0)) { a %= b; constexpr_swap(a, b); } return a; } template inline BOOST_CXX14_CONSTEXPR BOOST_DEDUCED_TYPENAME enable_if_c::method == method_mixed, T>::type optimal_gcd_select(T const &a, T const &b) BOOST_GCD_NOEXCEPT(T) { return gcd_detail::mixed_binary_gcd(a, b); } template inline BOOST_CXX14_CONSTEXPR BOOST_DEDUCED_TYPENAME enable_if_c::method == method_binary, T>::type optimal_gcd_select(T const &a, T const &b) BOOST_GCD_NOEXCEPT(T) { return gcd_detail::Stein_gcd(a, b); } template inline BOOST_CXX14_CONSTEXPR BOOST_DEDUCED_TYPENAME enable_if_c::method == method_euclid, T>::type optimal_gcd_select(T const &a, T const &b) BOOST_GCD_NOEXCEPT(T) { return gcd_detail::Euclid_gcd(a, b); } template inline BOOST_CXX14_CONSTEXPR T lcm_imp(const T& a, const T& b) BOOST_GCD_NOEXCEPT(T) { T temp = boost::integer::gcd_detail::optimal_gcd_select(a, b); #if BOOST_WORKAROUND(BOOST_GCC_VERSION, < 40500) return (temp != T(0)) ? T(a / temp * b) : T(0); #else return temp != T(0) ? T(a / temp * b) : T(0); #endif } } // namespace detail template inline BOOST_CXX14_CONSTEXPR Integer gcd(Integer const &a, Integer const &b) BOOST_GCD_NOEXCEPT(Integer) { if(a == (std::numeric_limits::min)()) return a == static_cast(0) ? gcd_detail::gcd_traits::abs(b) : boost::integer::gcd(static_cast(a % b), b); else if (b == (std::numeric_limits::min)()) return b == static_cast(0) ? gcd_detail::gcd_traits::abs(a) : boost::integer::gcd(a, static_cast(b % a)); return gcd_detail::optimal_gcd_select(static_cast(gcd_detail::gcd_traits::abs(a)), static_cast(gcd_detail::gcd_traits::abs(b))); } template inline BOOST_CXX14_CONSTEXPR Integer lcm(Integer const &a, Integer const &b) BOOST_GCD_NOEXCEPT(Integer) { return gcd_detail::lcm_imp(static_cast(gcd_detail::gcd_traits::abs(a)), static_cast(gcd_detail::gcd_traits::abs(b))); } #ifndef BOOST_NO_CXX11_VARIADIC_TEMPLATES // // This looks slightly odd, but the variadic forms must have 3 or more arguments, and the variadic argument pack may be empty. // This matters not at all for most compilers, but Oracle C++ selects the wrong overload in the 2-arg case unless we do this. // template inline BOOST_CXX14_CONSTEXPR Integer gcd(Integer const &a, Integer const &b, const Integer& c, Args const&... args) BOOST_GCD_NOEXCEPT(Integer) { Integer t = gcd(b, c, args...); return t == 1 ? 1 : gcd(a, t); } template inline BOOST_CXX14_CONSTEXPR Integer lcm(Integer const &a, Integer const &b, Integer const& c, Args const&... args) BOOST_GCD_NOEXCEPT(Integer) { return lcm(a, lcm(b, c, args...)); } #endif // // Special handling for rationals: // template inline typename boost::enable_if_c::is_specialized, boost::rational >::type gcd(boost::rational const &a, boost::rational const &b) { return boost::rational(static_cast(gcd(a.numerator(), b.numerator())), static_cast(lcm(a.denominator(), b.denominator()))); } template inline typename boost::enable_if_c::is_specialized, boost::rational >::type lcm(boost::rational const &a, boost::rational const &b) { return boost::rational(static_cast(lcm(a.numerator(), b.numerator())), static_cast(gcd(a.denominator(), b.denominator()))); } /** * Knuth, The Art of Computer Programming: Volume 2, Third edition, 1998 * Chapter 4.5.2, Algorithm C: Greatest common divisor of n integers. * * Knuth counts down from n to zero but we naturally go from first to last. * We also return the termination position because it might be useful to know. * * Partly by quirk, partly by design, this algorithm is defined for n = 1, * because the gcd of {x} is x. It is not defined for n = 0. * * @tparam I Input iterator. * @return The gcd of the range and the iterator position at termination. */ template std::pair::value_type, I> gcd_range(I first, I last) BOOST_GCD_NOEXCEPT(I) { BOOST_ASSERT(first != last); typedef typename std::iterator_traits::value_type T; T d = *first++; while (d != T(1) && first != last) { d = gcd(d, *first); first++; } return std::make_pair(d, first); } template std::pair::value_type, I> lcm_range(I first, I last) BOOST_GCD_NOEXCEPT(I) { BOOST_ASSERT(first != last); typedef typename std::iterator_traits::value_type T; T d = *first++; while (d != T(1) && first != last) { d = lcm(d, *first); first++; } return std::make_pair(d, first); } template < typename IntegerType > class gcd_evaluator #ifdef BOOST_NO_CXX11_HDR_FUNCTIONAL : public std::binary_function #endif { public: #ifndef BOOST_NO_CXX11_HDR_FUNCTIONAL typedef IntegerType first_argument_type; typedef IntegerType second_argument_type; typedef IntegerType result_type; #endif IntegerType operator()(IntegerType const &a, IntegerType const &b)const { return boost::integer::gcd(a, b); } }; template < typename IntegerType > class lcm_evaluator #ifdef BOOST_NO_CXX11_HDR_FUNCTIONAL : public std::binary_function #endif { public: #ifndef BOOST_NO_CXX11_HDR_FUNCTIONAL typedef IntegerType first_argument_type; typedef IntegerType second_argument_type; typedef IntegerType result_type; #endif IntegerType operator()(IntegerType const &a, IntegerType const &b)const { return boost::integer::lcm(a, b); } }; } // namespace integer } // namespace boost #ifdef BOOST_MSVC #pragma warning(pop) #endif #endif // BOOST_INTEGER_COMMON_FACTOR_RT_HPP