Struct Error

pub struct Error<F, In> { /* private fields */ }

Aggregator structure that compares computed and real values, input by input, computes the corresponding errors and stores them.

The first generic parameter specifies the type of floating point used. The second one specifies the input argument(s). In most cases, this will be a single floating point number, however, for multiple argument functions this can be a tuple.

Implementations

impl<F: FloatExt, In: Debug + Default + Copy> Error<F, In>

pub fn new() -> Self

Initializes the structure without any bounds.

pub fn with_bounds(bounds: ErrorBounds<F>) -> Self

Initializes the structure with given bounds.

pub fn calculate(&mut self, arg: In, computed: F, real: F)

Calculates the errors between computed value and real value. If it is the current maximum, its value is stored along with the argument that caused it.

pub fn max_rel(&self) -> F

Returns maximum relative error encountered.

pub fn max_rel_arg(&self) -> In

Returns the argument for maximum relative error encountered.

pub fn max_abs(&self) -> F

Returns maximum absolute error encountered.

pub fn max_abs_arg(&self) -> In

Returns the argument for absolute relative error encountered.

pub fn rms(&self) -> F

Returns root-mean-square error for all values encountered.

pub fn assert(&self)

Asserts the bounds for the errors that were encountered.

pub fn print_plain(&self, name: &str)

Prints the errors (and arguments) in a plain, human-readable form.

pub fn print_csv(&self, name: &str)

Prints the errors (and arguments) as one line in CSV format. Use print_csv_header method to print the header for the CSV file.

pub fn print_csv_header()

Prints the header for CSV file which contents are given by print_csv method.