org.simulator.math

Class MaxDivergenceTolerance

java.lang.Object

org.simulator.math.QualityMeasure

org.simulator.math.MaxDivergenceTolerance

All Implemented Interfaces:

Serializable

public class MaxDivergenceTolerance
extends QualityMeasure

An implementation of core comparison metric of the simulator's result with the pre-defined results. MaxDivergenceTolerance class basically calculates the LHS of the below given metric.

Metric Formula: $$\frac{|c_{ij}-<!--\; -\; -->u_{ij}|}{T_a+T_r\cdot <!--\; \cdot \; -->\left|c_{ij}\right|}\le <!--\; \le \; -->1\frac{}{}$$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MaxDivergenceTolerance(double absTol, double relTol) Default constructor.

Method Summary

Modifier and Type	Method and Description
double	distance(MultiTable.Block.Column x, MultiTable.Block.Column y, double defaultValue) Returns the distance of the two vectors x and y with the given root.

Methods inherited from class org.simulator.math.QualityMeasure

distance, distance, getColumnDistances, getDefaultValue, getMaxAbsDistances, getMeanFunction, setDefaultValue, setMeanFunction

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaxDivergenceTolerance

public MaxDivergenceTolerance(double absTol,
                              double relTol)

Default constructor. Initializes the metric MaxAbsDistance and sets the absolute and relative tolerances.

Parameters:

absTol -

relTol -

Method Detail

distance

public double distance(MultiTable.Block.Column x,
                       MultiTable.Block.Column y,
                       double defaultValue)

Returns the distance of the two vectors x and y with the given root. This may be the root in a formal way or a default value to be returned if the distance uses a non defined operation. If one array is longer than the other one additional values do not contribute to the distance. Double.NaN values are also ignored.

Specified by:

distance in class QualityMeasure

Parameters:

x - an array

y - another array

defaultValue - The value to be returned in cases in which no distance computation is possible.

Returns:

The distance between the two arrays x and y.