is_zero.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-2-Clause
 
#ifndef pRC_CORE_VALUE_FUNCTIONS_IS_ZERO_H
#define pRC_CORE_VALUE_FUNCTIONS_IS_ZERO_H
 
#include <prc/core/basic/functions/zero.hpp>
#include <prc/core/functors/absolute_error.hpp>
#include <prc/core/value/functions/absolute_error.hpp>
#include <prc/core/value/limits.hpp>
 
namespace pRC
{
    template<class X, class R = RemoveReference<X>, IsValue TT = Value<R>>
        requires IsDefined<Zero<R>> && IsConstructible<Zero<R>> &&
        IsInvocable<AbsoluteError, decltype(zero<R>()), X>
    static inline constexpr auto isZero(X &&a,
        TT const &tolerance = NumericLimits<TT>::tolerance())
    {
        return absoluteError(zero<R>(), forward<X>(a)) <= tolerance;
    }
}
#endif // pRC_CORE_VALUE_FUNCTIONS_IS_ZERO_H