RangeValidator< ErrorType > Class Template Reference

Detailed Description

template<typename ErrorType = maliput::common::assertion_error>
class maliput::common::RangeValidator< ErrorType >

Functor to validate if a number is within [min, max] and considering assuming a tolerance.

This tolerance extends the range to be [min - tolerance, max + tolerance]. The functor not only validates that number is within the range, but also adapts it to be in the interval (min, max) where the difference between the close and open range is epsilon. This functor is motivated to wrap MALIPUT_VALIDATE() calls plus a std::clamp() to avoid throws for numerical errors.

#include <include/maliput/common/range_validator.h>

Public Member Functions
	RangeValidator ()=delete
double	operator() (double s) const
	Evaluates whether s is in range or not. More...

Static Public Member Functions
static RangeValidator< ErrorType >	GetRelativeEpsilonValidator (double min, double max, double tolerance, double epsilon)
	Creates a RangeValidator instance that uses a relative epsilon to validate the values. More...
static RangeValidator< ErrorType >	GetAbsoluteEpsilonValidator (double min, double max, double tolerance, double epsilon)
	Creates a RangeValidator instance that uses a epsilon as the absolute epsilon to validate the values. More...

Constructor & Destructor Documentation

RangeValidator()

RangeValidator ( )

delete

Member Function Documentation

GetAbsoluteEpsilonValidator()

static RangeValidator<ErrorType> GetAbsoluteEpsilonValidator ( double  min, double  max, double  tolerance, double  epsilon  )

static

Creates a RangeValidator instance that uses a epsilon as the absolute epsilon to validate the values.

Parameters

min	lower extreme of the range.
max	upper extreme of the range.
tolerance	is the range extension to be accepted.
epsilon	is minimum difference that separates a number within the range to be distinct from range extremes (min and max).

Template Parameters

ErrorType

The error type to be thrown.

Returns

A RangeValidator instance.

Exceptions

ErrorType	When tolerance is non positive.
ErrorType	When epsilon is not in [0, tolerance].
ErrorType	When min + epsilon > max or max - epsilon < min

GetRelativeEpsilonValidator()

static RangeValidator<ErrorType> GetRelativeEpsilonValidator ( double  min, double  max, double  tolerance, double  epsilon  )

static

Creates a RangeValidator instance that uses a relative epsilon to validate the values.

This relative epsilon is computed by multiplying epsilon by the range.

Parameters

min	lower extreme of the range.
max	upper extreme of the range.
tolerance	is the range extension to be accepted.
epsilon	is the relative minimum difference that separates a number within range to be distinct from extremes. It is relative to the range.

Template Parameters

ErrorType

The error type to be thrown.

Returns

A RangeValidator instance.

Exceptions

ErrorType	When tolerance is non positive.
ErrorType	When epsilon is not in [0, tolerance].
ErrorType	When min + epsilon > max or max - epsilon < min

operator()()

double operator()

(

double

s

)

const

Evaluates whether s is in range or not.

Parameters

s	value to check if it is in range.

Returns

s when it is within the open range. If s is equal to either range extremes or the difference to them is less or equal to tolerance, it returns the closest open range value.

Exceptions

ErrorType

if s is out of range.

---

The documentation for this class was generated from the following file:

• range_validator.h