Struct ErrorSet

Defined in File AggregateErrors.hpp

Inheritance Relationships

Derived Types

public GridKit::Testing::ErrorSetImpl< AbsoluteError > (Template Struct ErrorSetImpl< AbsoluteError >)
public GridKit::Testing::ErrorSetImpl< RelativeError > (Template Struct ErrorSetImpl< RelativeError >)

Struct Documentation

struct ErrorSet

A set of aggregate norms (represented with TemporalNormAggregate) for the error in each variable plus one for the total (combined) error.

Note

The “total_error” aggregate is based on the L-infinity norm of the local error of variables at a given time step.

Subclassed by GridKit::Testing::ErrorSetImpl< AbsoluteError >, GridKit::Testing::ErrorSetImpl< RelativeError >

Public Functions

template<typename C> inline explicit ErrorSet(const C &labels): Construct with variable labels.

inline virtual void wrap(): Finalize the calculations.

virtual void push(const OutputAtTime&, const OutputAtTime&) = 0: Take the error between the two output parameters for each variable and add to the aggregate.

inline std::ostream &display(std::ostream &os = std::cout) const: Pretty-print the set of errors for each variable and total.

Public Members

TemporalNormAggregate total_error = {"Total"}: Aggregate of the combined error value at each time step.

std::vector<TemporalNormAggregate> var_errors = {}: Aggregate error for each variable.