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

java.lang.Object
  extended by at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric
      extended by at.tuwien.ifs.somtoolbox.layers.metrics.L1Metric
All Implemented Interfaces:
DistanceMetric, Comparable<DistanceMetric>

public class L1Metric
extends AbstractMetric
implements DistanceMetric

Implements the L1 or city block 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: L1Metric.java 3583 2010-05-21 10:07:41Z mayer $
Author:
Michael Dittenbach

Nested Class Summary
 
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
L1Metric()
           
 
Method Summary
 double distance(double[] vector1, double[] vector2)
          Calculates the distance between two vectors provided by argument vector1 and vector2.
 double distance(cern.colt.matrix.DoubleMatrix1D vector1, cern.colt.matrix.DoubleMatrix1D vector2)
          Calculates the distance between two vectors provided by argument vector1 and vector2.
 String toString()
           
 
Methods inherited from class at.tuwien.ifs.somtoolbox.layers.metrics.AbstractMetric
checkDimensions, checkDimensions, compareTo, 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, setMetricParams, transformValue, transformVector
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

L1Metric

public L1Metric()
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[])

distance

public double distance(cern.colt.matrix.DoubleMatrix1D vector1,
                       cern.colt.matrix.DoubleMatrix1D 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
Overrides:
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(cern.colt.matrix.DoubleMatrix1D, cern.colt.matrix.DoubleMatrix1D)

toString

public String toString()
Overrides:
toString in class Object