relative_error.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-2-Clause
 
#ifndef pRC_CORE_VALUE_FUNCTIONS_RELATIVE_ERROR_H
#define pRC_CORE_VALUE_FUNCTIONS_RELATIVE_ERROR_H
 
#include <prc/core/functors/absolute_error.hpp>
#include <prc/core/functors/div.hpp>
#include <prc/core/functors/norm.hpp>
#include <prc/core/functors/relative_error.hpp>
#include <prc/core/value/functions/absolute_error.hpp>
#include <prc/core/value/functions/cast.hpp>
#include <prc/core/value/functions/div.hpp>
#include <prc/core/value/functions/norm.hpp>
 
namespace pRC
{
    template<class XE, class XA>
        requires IsInvocable<AbsoluteError, XE, XA> && IsInvocable<Norm<>, XE>
    static inline constexpr auto relativeError(XE &&expected, XA &&approx)
    {
        auto const nrm = norm(expected);
        using V = Value<decltype(nrm)>;
 
        return absoluteError(expected, approx) /
            Conditional<IsInteger<V>, Float<>, V>(nrm);
    }
}
#endif // pRC_CORE_VALUE_FUNCTIONS_RELATIVE_ERROR_H