org.simulator.math

Class RelativeMaxDistance

java.lang.Object

org.simulator.math.QualityMeasure

org.simulator.math.RelativeMaxDistance

All Implemented Interfaces:

Serializable

public class RelativeMaxDistance
extends QualityMeasure

Computes the relative distance of two vectors based on the MaxAbsDistance distance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RelativeMaxDistance() Default Constructor
RelativeMaxDistance(MaxAbsDistance metric) Initialization with a given MaxAbsDistance

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

RelativeMaxDistance

public RelativeMaxDistance()

Default Constructor

RelativeMaxDistance

public RelativeMaxDistance(MaxAbsDistance metric)

Initialization with a given MaxAbsDistance

Parameters:

metric -

Method Detail

distance

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

Description copied from class: QualityMeasure

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.