essentiallyEqual.hpp

Go to the documentation of this file.

#pragma once
 
#include <cmath>
#include <complex>
#include <string>
 
#include "NumCpp/Core/DtypeInfo.hpp"
#include "NumCpp/Core/Internal/TypeTraits.hpp"
 
namespace nc::utils
{
    //============================================================================
    // Method Description:
    template<typename dtype, std::enable_if_t<std::is_integral<dtype>::value, int> = 0>
    bool essentiallyEqual(dtype inValue1, dtype inValue2) noexcept
    {
        return inValue1 == inValue2;
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, std::enable_if_t<std::is_floating_point<dtype>::value, int> = 0>
    bool essentiallyEqual(dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept
    {
        const auto absValue1 = std::abs(inValue1);
        const auto absValue2 = std::abs(inValue2);
        return std::abs(inValue1 - inValue2) <= ((absValue1 > absValue2 ? absValue2 : absValue1) * std::abs(inEpsilon));
    }
 
    //============================================================================
    // Method Description:
    template<typename dtype, std::enable_if_t<std::is_floating_point<dtype>::value, int> = 0>
    bool essentiallyEqual(dtype inValue1, dtype inValue2) noexcept
    {
        return essentiallyEqual(inValue1, inValue2, DtypeInfo<dtype>::epsilon());
    }
} // namespace nc::utils