at.tuwien.ifs.somtoolbox.layers.metrics
Class L2Metric

java.lang.Object
  at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric
      at.tuwien.ifs.somtoolbox.layers.metrics.L2Metric

All Implemented Interfaces:

DistanceMetric, Comparable<DistanceMetric>

Direct Known Subclasses:

L2MetricFast, MnemonicSOMMetric

public class L2Metric
extends AbstractMetric
implements DistanceMetric

Implements the L2 or Euclidean metric. Though this class could us at.tuwien.ifs.somtoolbox.layers.metrics.LNMetric, for performance issues this less complex computation should be used.

Version:

$Id: L2Metric.java 3883 2010-11-02 17:13:23Z frank $

Author:

Michael Dittenbach

Nested Class Summary

(package private) class

L2Metric.L2MetricMatrix

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

DistanceMetric.SparcseMetricModes

Field Summary

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

PACKAGE_NAME

Constructor Summary

L2Metric()

Method Summary

double	distance(double[] vector1, double[] vector2) Calculates the distance between two vectors provided by argument vector1 and vector2.
static void	main(String[] args)
double	norm(double[] vector)
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

Methods inherited from interface at.tuwien.ifs.somtoolbox.layers.metrics.DistanceMetric

distance, distance, distance, distance, distance, distance, distance, distance, setMetricParams, transformValue, transformVector

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

L2Metric

public L2Metric()

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[])

norm

public double norm(double[] vector)

Returns:

the norm of the vector.

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)