Merge pull request #295 from bluescarni/pr/real_iter

Real additions

Author: bluescarni

.circleci/config.yml

@@ -77,8 +77,8 @@ workflows:
   version: 2.1
   all_builds:
     jobs:
-    - focal_clang9_msan_00
-    - focal_clang9_msan_01
+    # - focal_clang9_msan_00
+    # - focal_clang9_msan_01
     - bionic_gcc7_conda_coverage
     - bionic_gcc7_conda_release
     - focal_gcc9_conda_coverage

.clang-tidy

@@ -1,5 +1,5 @@
 ---
-Checks:          'clang-diagnostic-*,clang-analyzer-*,*,-hicpp-uppercase-literal-suffix,-readability-uppercase-literal-suffix,-modernize-use-trailing-return-type,-readability-named-parameter,-hicpp-named-parameter,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-hicpp-no-array-decay,-llvm-header-guard,-cppcoreguidelines-macro-usage,-google-runtime-references,-readability-isolate-declaration,-fuchsia-default-arguments-calls,-fuchsia-overloaded-operator,-fuchsia-default-arguments-declarations,-readability-else-after-return,-google-runtime-int,-hicpp-signed-bitwise,-cert-dcl21-cpp,-cppcoreguidelines-avoid-magic-numbers,-readability-magic-numbers,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-avoid-c-arrays,-hicpp-avoid-c-arrays,-modernize-avoid-c-arrays,-modernize-use-transparent-functors,-cert-dcl16-c,-cppcoreguidelines-pro-type-union-access,-bugprone-branch-clone,-fuchsia-statically-constructed-objects,-cppcoreguidelines-pro-bounds-constant-array-index,-readability-static-accessed-through-instance,-cppcoreguidelines-pro-type-vararg,-hicpp-vararg,-llvmlibc-restrict-system-libc-headers,-llvmlibc-callee-namespace,-llvmlibc-implementation-in-namespace,-llvm-else-after-return,-altera-struct-pack-align,-readability-function-cognitive-complexity'
+Checks:          'clang-diagnostic-*,clang-analyzer-*,*,-hicpp-uppercase-literal-suffix,-readability-uppercase-literal-suffix,-modernize-use-trailing-return-type,-readability-named-parameter,-hicpp-named-parameter,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-hicpp-no-array-decay,-llvm-header-guard,-cppcoreguidelines-macro-usage,-google-runtime-references,-readability-isolate-declaration,-fuchsia-default-arguments-calls,-fuchsia-overloaded-operator,-fuchsia-default-arguments-declarations,-readability-else-after-return,-google-runtime-int,-hicpp-signed-bitwise,-cert-dcl21-cpp,-cppcoreguidelines-avoid-magic-numbers,-readability-magic-numbers,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-avoid-c-arrays,-hicpp-avoid-c-arrays,-modernize-avoid-c-arrays,-modernize-use-transparent-functors,-cert-dcl16-c,-cppcoreguidelines-pro-type-union-access,-bugprone-branch-clone,-fuchsia-statically-constructed-objects,-cppcoreguidelines-pro-bounds-constant-array-index,-readability-static-accessed-through-instance,-cppcoreguidelines-pro-type-vararg,-hicpp-vararg,-llvmlibc-restrict-system-libc-headers,-llvmlibc-callee-namespace,-llvmlibc-implementation-in-namespace,-llvm-else-after-return,-altera-struct-pack-align,-readability-function-cognitive-complexity,-readability-identifier-length,-altera-unroll-loops,-altera-id-dependent-backward-branch'
 WarningsAsErrors: '*'
 AnalyzeTemporaryDtors: false
 FormatStyle:     none

cmake/yacma/YACMACompilerLinkerSettings.cmake

@@ -112,6 +112,13 @@ if(NOT _YACMACompilerLinkerSettingsRun)
         _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wsizeof-array-div)
         _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wxor-used-as-pow)
         _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wfinal-dtor-non-final-class)
+        # New warnings in clang 11.
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wpointer-to-int-cast)
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wuninitialized-const-reference)
+        # New warnings in clang 13.
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wunused-but-set-parameter)
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wunused-but-set-variable)
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wnull-pointer-subtraction)
         # NOTE: this is a new flag in Clang 13 which seems to give
         # incorrect warnings for UDLs.
         _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wno-reserved-identifier)
@@ -171,6 +178,12 @@ if(NOT _YACMACompilerLinkerSettingsRun)
             message(STATUS "Activating the '-Wno-maybe-uninitialized' workaround for GCC.")
             _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wno-maybe-uninitialized)
         endif()
+        # From GCC 10.
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wmismatched-tags)
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wredundant-tags)
+        # From GCC 12.
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Warray-compare)
+        _YACMA_CHECK_ENABLE_DEBUG_CXX_FLAG(-Wmissing-requires)
     endif()
 
     # MSVC setup.

doc/changelog.rst

@@ -4,6 +4,16 @@ Changelog
 0.27 (unreleased)
 -----------------
 
+New
+~~~
+
+- Add several ``std`` math overloads for :cpp:class:`~mppp::real`
+  (`#295 <https://github.com/bluescarni/mppp/pull/295>`__).
+- Add hashing capabilities to :cpp:class:`~mppp::real`
+  (`#295 <https://github.com/bluescarni/mppp/pull/295>`__).
+- Add a ``std::hash`` specialisation for :cpp:class:`~mppp::real128`
+  (`#295 <https://github.com/bluescarni/mppp/pull/295>`__).
+
 Changes
 ~~~~~~~
 

doc/conf.py.in

@@ -72,7 +72,7 @@ release = '@mp++_VERSION@'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -136,7 +136,15 @@ html_theme_options = {
     },
 }
 
-jupyter_execute_notebooks = "force"
+nb_execution_mode = "off"
+
+myst_enable_extensions = [
+    "amsmath",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "html_image",
+]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/real.rst

@@ -1555,24 +1555,34 @@ Arithmetic
    :return: :math:`-x`.
 
 .. cpp:function:: template <mppp::cvr_real T> mppp::real &mppp::abs(mppp::real &rop, T &&x)
+.. cpp:function:: template <mppp::cvr_real T> mppp::real &mppp::fabs(mppp::real &rop, T &&x)
 
    Binary :cpp:class:`~mppp::real` absolute value.
 
-   This function will set *rop* to :math:`\left| x \right|`. The precision of the result will be
+   These functions will set *rop* to :math:`\left| x \right|`. The precision of the result will be
    equal to the precision of *x*.
 
+   .. versionadded:: 0.27
+
+      The ``fabs()`` overload.
+
    :param rop: the return value.
    :param x: the operand.
 
    :return: a reference to *rop*.
 
 .. cpp:function:: template <mppp::cvr_real T> mppp::real mppp::abs(T &&x)
+.. cpp:function:: template <mppp::cvr_real T> mppp::real mppp::fabs(T &&x)
 
    Unary :cpp:class:`~mppp::real` absolute value.
 
-   This function will return :math:`\left| x \right|`. The precision of the result will be
+   These functions will return :math:`\left| x \right|`. The precision of the result will be
    equal to the precision of *x*.
 
+   .. versionadded:: 0.27
+
+      The ``fabs()`` overload.
+
    :param x: the operand.
 
    :return: :math:`\left| x \right|`.
@@ -1685,8 +1695,11 @@ Comparison
 ~~~~~~~~~~
 
 .. cpp:function:: bool mppp::nan_p(const mppp::real &r)
+.. cpp:function:: bool mppp::isnan(const mppp::real &r)
 .. cpp:function:: bool mppp::inf_p(const mppp::real &r)
+.. cpp:function:: bool mppp::isinf(const mppp::real &r)
 .. cpp:function:: bool mppp::number_p(const mppp::real &r)
+.. cpp:function:: bool mppp::isfinite(const mppp::real &r)
 .. cpp:function:: bool mppp::zero_p(const mppp::real &r)
 .. cpp:function:: bool mppp::regular_p(const mppp::real &r)
 .. cpp:function:: bool mppp::integer_p(const mppp::real &r)
@@ -1696,16 +1709,20 @@ Comparison
 
    These functions will return ``true`` if *r* is, respectively:
 
-   * NaN,
-   * an infinity,
-   * a finite number,
-   * zero,
-   * a regular number (i.e., not NaN, infinity or zero),
-   * an integral value,
-   * one,
+   * NaN (``nan_p()`` and ``isnan()``),
+   * an infinity (``inf_p()`` and ``isinf()``),
+   * a finite number (``number_p()`` and ``isfinite()``),
+   * zero (``zero_p()``),
+   * a regular number (i.e., not NaN, infinity or zero) (``regular_p()``),
+   * an integral value (``integer_p()``),
+   * one (``is_one()``),
 
    ``false`` otherwise.
 
+   .. versionadded:: 0.27
+
+      The ``isnan()``, ``isinf()`` and ``isfinite()`` overloads.
+
    :param r: the input argument.
 
    :return: the result of the detection.
@@ -3184,6 +3201,21 @@ Serialisation
 
    :exception unspecified: any exception thrown by the invoked :cpp:func:`mppp::real::binary_load()` overload.
 
+Other
+~~~~~
+
+.. cpp:function:: std::size_t mppp::hash(const mppp::real &x)
+
+   .. versionadded:: 0.27
+
+   Hash function for :cpp:class:`~mppp::real`.
+
+   This function guarantees that ``x == y`` implies ``hash(x) == hash(y)``.
+
+   :param x: the argument.
+
+   :return: a hash value for *x*.
+
 .. _real_operators:
 
 Mathematical operators
@@ -3348,6 +3380,30 @@ Constants
 
    :return: a reference to *rop*.
 
+Standard library specialisations
+--------------------------------
+
+.. cpp:class:: template <> std::hash<mppp::real>
+
+   .. versionadded:: 0.27
+
+   Specialisation of ``std::hash`` for :cpp:class:`mppp::real`.
+
+   The hash is computed via :cpp:func:`std::size_t mppp::hash(const mppp::real &)`.
+
+   .. cpp:type:: public argument_type = mppp::real
+   .. cpp:type:: public result_type = std::size_t
+
+   .. note::
+
+      The :cpp:type:`argument_type` and :cpp:type:`result_type` type aliases are defined only until C++14.
+
+   .. cpp:function:: public std::size_t operator()(const mppp::real &x) const
+
+      :param x: the input :cpp:class:`mppp::real`.
+
+      :return: a hash value for *x*.
+
 .. _real_literals:
 
 User-defined literals

doc/real128.rst

@@ -1379,8 +1379,7 @@ Other
 
    Hash function for :cpp:class:`~mppp::real128`.
 
-   All NaN values produce the same hash value. For non-NaN arguments, this function
-   guarantees that ``x == y`` implies ``hash(x) == hash(y)``.
+   This function guarantees that ``x == y`` implies ``hash(x) == hash(y)``.
 
    :param x: the argument.
 
@@ -1647,6 +1646,27 @@ Standard library specialisations
 
      :return: the output of :cpp:func:`mppp::real128_denorm_min()`.
 
+.. cpp:class:: template <> std::hash<mppp::real128>
+
+   .. versionadded:: 0.27
+
+   Specialisation of ``std::hash`` for :cpp:class:`mppp::real128`.
+
+   The hash is computed via :cpp:func:`std::size_t mppp::hash(const mppp::real128 &)`.
+
+   .. cpp:type:: public argument_type = mppp::real128
+   .. cpp:type:: public result_type = std::size_t
+
+   .. note::
+
+      The :cpp:type:`argument_type` and :cpp:type:`result_type` type aliases are defined only until C++14.
+
+   .. cpp:function:: public std::size_t operator()(const mppp::real128 &x) const
+
+      :param x: the input :cpp:class:`mppp::real128`.
+
+      :return: a hash value for *x*.
+
 .. _real128_literals:
 
 User-defined literals

include/mp++/detail/utils.hpp

@@ -10,6 +10,8 @@
 #define MPPP_DETAIL_UTILS_HPP
 
 #include <cassert>
+#include <cstddef>
+#include <functional>
 #include <limits>
 #include <stdexcept>
 #include <string>
@@ -298,6 +300,14 @@ inline make_signed_t<T> make_signed(const T &n, int s)
     return static_cast<make_signed_t<T>>((n ^ s_ex) - s_ex);
 }
 
+// The hash combiner. This is lifted directly from Boost. See also:
+// http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3876.pdf
+template <typename T>
+inline void hash_combine(std::size_t &seed, const T &val)
+{
+    seed ^= std::hash<T>{}(val) + static_cast<std::size_t>(0x9e3779b9ull) + (seed << 6) + (seed >> 2);
+}
+
 #if defined(_MSC_VER)
 
 #pragma warning(pop)

include/mp++/integer.hpp

@@ -7037,13 +7037,12 @@ inline std::size_t hash(const integer<SSize> &n)
         = size >= 0 ? static_cast<std::size_t>(size) : static_cast<std::size_t>(detail::nint_abs(size));
     const ::mp_limb_t *ptr
         = n._get_union().is_static() ? n._get_union().g_st().m_limbs.data() : n._get_union().g_dy()._mp_d;
-    // Init the retval as the signed size.
-    auto retval = static_cast<std::size_t>(size);
+    // Init the retval as the hash of the signed size.
+    auto retval = std::hash<detail::mpz_size_t>{}(size);
     // Combine the limbs.
     for (std::size_t i = 0; i < asize; ++i) {
-        // The hash combiner. This is lifted directly from Boost. See also:
-        // http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3876.pdf
-        retval ^= (ptr[i] & GMP_NUMB_MASK) + std::size_t(0x9e3779b9ul) + (retval << 6) + (retval >> 2);
+        // Combine the hashes of the limbs.
+        detail::hash_combine(retval, ptr[i] & GMP_NUMB_MASK);
     }
     return retval;
 }
@@ -8200,7 +8199,7 @@ namespace std
 // Specialisation of std::hash for mppp::integer.
 template <size_t SSize>
 struct hash<mppp::integer<SSize>> {
-// NOTE: these typedefs have been deprecated in C++17.
+    // NOTE: these typedefs have been deprecated in C++17.
 #if MPPP_CPLUSPLUS < 201703L
     // The argument type.
     using argument_type = mppp::integer<SSize>;