File: fp_compare.h

package info (click to toggle)
llvm-toolchain-16 1%3A16.0.6-15~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,634,792 kB
  • sloc: cpp: 6,179,261; ansic: 1,216,205; asm: 741,319; python: 196,614; objc: 75,325; f90: 49,640; lisp: 32,396; pascal: 12,286; sh: 9,394; perl: 7,442; ml: 5,494; awk: 3,523; makefile: 2,723; javascript: 1,206; xml: 886; fortran: 581; cs: 573
file content (47 lines) | stat: -rw-r--r-- 1,484 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef SUPPORT_FP_COMPARE_H
#define SUPPORT_FP_COMPARE_H

#include <cmath>      // for std::abs
#include <algorithm>  // for std::max
#include <cassert>

// See https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/boost_test/testing_tools/extended_comparison/floating_point/floating_points_comparison_theory.html

template<typename T>
bool fptest_close(T val, T expected, T eps)
{
    constexpr T zero = T(0);
    assert(eps >= zero);

    // Handle the zero cases
    if (eps      == zero) return val == expected;
    if (val      == zero) return std::abs(expected) <= eps;
    if (expected == zero) return std::abs(val)      <= eps;

    return std::abs(val - expected) < eps
        && std::abs(val - expected)/std::abs(val) < eps;
}

template<typename T>
bool fptest_close_pct(T val, T expected, T percent)
{
    constexpr T zero = T(0);
    assert(percent >= zero);

    // Handle the zero cases
    if (percent == zero) return val == expected;
    T eps = (percent / T(100)) * std::max(std::abs(val), std::abs(expected));

    return fptest_close(val, expected, eps);
}


#endif // SUPPORT_FP_COMPARE_H