at.tuwien.ifs.somtoolbox.layers.metrics

Class L2MetricSparse

java.lang.Object

at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric

at.tuwien.ifs.somtoolbox.layers.metrics.L2MetricSparse

All Implemented Interfaces:

DistanceMetric, java.lang.Comparable<DistanceMetric>

public class L2MetricSparse
extends AbstractMetric

Implements the L2 or Euclidean metric, considering only those values for the distance calculation that have non-zero values for the first, second or both vectors, depending on the initialisation mode.

Version:

$Id: L2MetricSparse.java 3583 2010-05-21 10:07:41Z mayer $

Author:

Rudolf Mayer

Nested Class Summary

Nested classes/interfaces inherited from interface at.tuwien.ifs.somtoolbox.layers.metrics.DistanceMetric

DistanceMetric.SparcseMetricModes

Field Summary

Fields

Modifier and Type	Field and Description
private DistanceMetric.SparcseMetricModes	mode

Fields inherited from class at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric

PACKAGE_NAME

Constructor Summary

Constructors

Constructor and Description
L2MetricSparse() Initialises the metric with DistanceMetric.SparcseMetricModes.FIRST_NON_ZERO.
L2MetricSparse(DistanceMetric.SparcseMetricModes mode)

Method Summary

Modifier and Type	Method and Description
double	distance(double[] vector1, double[] vector2) Calculates the distance between two vectors provided by argument vector1 and vector2.
java.lang.String	toString()

Methods inherited from class at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric

checkDimensions, checkDimensions, compareTo, distance, distance, distance, distance, distance, distance, distance, distance, instantiate, instantiateNice, meanVector, performanceTest, setMetricParams, transformValue, transformVector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mode

private DistanceMetric.SparcseMetricModes mode

Constructor Detail

L2MetricSparse

public L2MetricSparse()

Initialises the metric with DistanceMetric.SparcseMetricModes.FIRST_NON_ZERO.

L2MetricSparse

public L2MetricSparse(DistanceMetric.SparcseMetricModes mode)

Method Detail

distance

public double distance(double[] vector1,
                       double[] vector2)
                throws MetricException

Description copied from interface: DistanceMetric

Calculates the distance between two vectors provided by argument vector1 and vector2. A MetricException is thrown, if the dimensionalities of the two vectors differ.

Specified by:

distance in interface DistanceMetric

Specified by:

distance in class AbstractMetric

Parameters:

vector1 - first vector.

vector2 - second vector.

Returns:

the distance between vector1 and vector2.

Throws:

MetricException - if the dimensionalities of the two vectors differ.

See Also:

DistanceMetric.distance(double[], double[])

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object