GCC Code Coverage Report


Directory: include/polyfloat/
File: include/polyfloat/module/core/is_equal.hpp
Date: 2026-11-09 15:28:50
Exec Total Coverage
Lines: 6 6 100.0%
Functions: 64 64 100.0%
Branches: 0 0 -%

Line Branch Exec Source
1 //======================================================================================================================
2 /*
3 POLYFLOAT - Extended precision floating points
4 Copyright : POLYFLOAT Contributors & Maintainers
5 SPDX-License-Identifier: BSL-1.0
6 */
7 //======================================================================================================================
8 #pragma once
9
10 #include <polyfloat/details/callable.hpp>
11 #include <polyfloat/types/concepts.hpp>
12 #include <polyfloat/types/traits.hpp>
13 #include <type_traits>
14
15 namespace plf
16 {
17
18 template<typename Options>
19 struct is_equal_t : plf::callable<is_equal_t, eve::is_equal_t, Options, raw_option, pedantic_option, numeric_option>
20 {
21 template<concepts::polyfloat_like Z1, concepts::polyfloat_like Z2>
22 1714 POLYFLOAT_ABI constexpr eve::as_logical_t<as_polyfloat_like_t<Z1, Z2>> operator()(Z1 z1, Z2 z2) const noexcept
23 {
24 1714 return POLYFLOAT_CALL(z1, z2);
25 }
26
27 1710 POLYFLOAT_CALLABLE_OBJECT(is_equal_t, is_equal_);
28 };
29 //======================================================================================================================
30 //! @addtogroup core
31 //! @{
32 //! @var is_equal
33 //! @brief test the parameters for equality.
34 //!
35 //! @groupheader{Header file}
36 //!
37 //! @code
38 //! #include <polyfloat/core.hpp>
39 //! @endcode
40 //!
41 //! @groupheader{Callable Signatures}
42 //!
43 //! @code
44 //! namespace polyfloat
45 //! {
46 //! template<polyfloat::concepts::polyfloat_like T1, polyfloat_like Z2> constexpr auto is_equal(T1 z1, T2 z2) noexcept; //1
47 //! template<polyfloat::concepts::polyfloat_like T1, polyfloat_like Z2> constexpr auto is_equal[numeric](T1 z1, T2 z2) noexcept; //2
48 //! }
49 //! @endcode
50 //!
51 //! **Parameters**
52 //!
53 //! * `z1`, `z2` : Values to process.
54 //!
55 //! **Return value**
56 //!
57 //! 1. Returns true is `z1` is equal to `z2`.
58 //! 2. consider nan values as equal
59 //!
60 //! @groupheader{Example}
61 //!
62 //! @godbolt{doc/core/is_equal.cpp}
63 //======================================================================================================================
64
65 inline constexpr auto is_equal = eve::functor<is_equal_t>;
66 //======================================================================================================================
67 //! @}
68 //======================================================================================================================
69 }
70
71 namespace plf::_
72 {
73 template<typename Z1, typename Z2, eve::callable_options O>
74 1710 constexpr auto is_equal_(POLYFLOAT_DELAY(), O const&, Z1 const& z1, Z2 const& z2) noexcept
75 {
76 1710 auto eq = z1 == z2;
77 if constexpr (O::contains(numeric)) return eq || (is_nan(z1) && is_nan(z2));
78 1710 else return eq;
79 }
80 }
81