ComPPare 1.0.0
Loading...
Searching...
No Matches
policy.hpp File Reference

This file contains error policies for comparing values in the ComPPare library. More...

Include dependency graph for policy.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  comppare::internal::policy::MetricValue< T >
 Wrapper for a value that can be streamed to an output stream. More...
 
struct  comppare::internal::policy::is_metric_value< typename >
 Partial specialisation for not a MetricValue. More...
 
struct  comppare::internal::policy::is_metric_value< MetricValue< U > >
 Partial specialisation for any MetricValue and returns true. More...
 
class  comppare::internal::policy::autopolicy::ArithmeticErrorPolicy< T >
 Concept for types supported by automatic error policy selection. More...
 
class  comppare::internal::policy::autopolicy::StringEqualPolicy
 Error policy for std::string. Compares two strings for equality. More...
 
class  comppare::internal::policy::autopolicy::RangeErrorPolicy< R >
 Error policy for ranges of arithmetic types. More...
 
struct  comppare::internal::policy::autopolicy::AutoPolicy< T >
 Partial specialization for types supported by automatic error policy selection. More...
 

Namespaces

namespace  comppare
 ComPPare framework main namespace.
 
namespace  comppare::internal
 
namespace  comppare::internal::policy
 
namespace  Namespace
 
namespace  comppare::internal::policy::autopolicy
 

Concepts

concept  comppare::internal::policy::IsMetricValue
 Concept for a MetricValue.
 
concept  comppare::internal::policy::ErrorPolicy
 Concept for a valid Error Policy.
 
concept  comppare::internal::policy::autopolicy::SupportedByAutoPolicy
 Concept for types supported by automatic error policy selection.
 

Typedefs

template<typename T >
using comppare::internal::policy::autopolicy::AutoPolicy_t = typename AutoPolicy< T >::type
 Helper alias to get the automatic error policy type for a given type T.
 

Functions

template<class EP , class V >
void comppare::internal::policy::compute_error (EP &ep, const V &a, const V &b)
 Wrapper function to compute the error using the given instance of the error policy.
 
template<class EP >
bool comppare::internal::policy::is_fail (const EP &ep)
 Wrapper function to check if the error policy indicates a failure.
 

Variables

template<typename M >
constexpr bool comppare::internal::policy::is_metric_value_v = is_metric_value<std::remove_cvref_t<M>>::value
 Checks if a type is a MetricValue.
 

Detailed Description

This file contains error policies for comparing values in the ComPPare library.

Author
Leong Fan FUNG (funglf) stanl.nosp@m.eyfu.nosp@m.nglf@.nosp@m.gmai.nosp@m.l.com
Date
2025
See also
LICENSE For full license text.