Struct nikisas_test::error::ErrorBounds

pub struct ErrorBounds<F> { /* fields omitted */ }

Bounds for errors to be asserted. By default, all are empty and therefore not checked. By specifying a bound for given error type, you enable checking it.

Examples

use nikisas_test::error::ErrorBounds;
// Specify bounds for relative and absolute errors.
let bounds = ErrorBounds::new().rel(0.001).abs(0.0001);

Implementations

impl<F: FloatExt> ErrorBounds<F>

pub fn new() -> Self

Creates empty bounds, that is, none is checked.

pub fn rel(self, bound: F) -> Self

Specifies the bound for maximum relative error.

pub fn abs(self, bound: F) -> Self

Specifies the bound for maximum absolute error.

pub fn rms(self, bound: F) -> Self

Specifies the bound for root-mean-square error.

pub fn check_rel_or_abs(&self, rel_err: F, abs_err: F) -> bool

Checks if the relative and absolute errors satisfy specified bounds.

pub fn check_abs(&self, abs_error: F) -> bool

Checks if the absolute error satisfies specified bound. This is mainly used when the relative error is undefined due to dividing by zero.

pub fn check_rms(&self, rms_error: F) -> bool

Checks if the root-mean-square error satisfies specified bound.