---

fl::MetricEuclidean Class Reference

#include <descriptor.h>

Inheritance diagram for fl::MetricEuclidean:

List of all members.

Public Methods
	MetricEuclidean (float upperBound=INFINITY)
	MetricEuclidean (std::istream &stream)
virtual float	value (const Vector< float > &value1, const Vector< float > &value2, bool preprocessed=false) const
virtual void	read (std::istream &stream)
virtual void	write (std::ostream &stream, bool withName=true)
Public Attributes
float	upperBound
	The largest possible distance, if known. Infinity if not known. Determines whether to use linear function or hyperbolic squashing function to map distance to resulting value.

---

Detailed Description

Uses the stardard Euclidean distance between two points. Maps zero distance to 1 and infinite (or alternately, maximum) distance to probability zero.

---

Constructor & Destructor Documentation

MetricEuclidean::MetricEuclidean (  float    upperBound = INFINITY )

Select between alternate squashing methods. There are two possible methods for converting a Euclidean distance [0,inf) to [0,1]. One is a hyperbolic squashing function that maps a distance of 0 to a value of 1 and a distance of inf to a value of 0. The other method, usable when the Euclidean distance is known to have an upper bound, is to map the distance to the output value with a linear transformation.

MetricEuclidean::MetricEuclidean (  std::istream &    stream )

---

Member Function Documentation

void MetricEuclidean::read (  std::istream &    stream )  [virtual]

Reimplemented from fl::Comparison.

float MetricEuclidean::value (  const Vector< float > &    value1, const Vector< float > &    value2, bool    preprocessed = false )  const [virtual]

Implements fl::Comparison.

void MetricEuclidean::write (  std::ostream &    stream, bool    withName = true )  [virtual]

Reimplemented from fl::Comparison.

---

Member Data Documentation

float fl::MetricEuclidean::upperBound

The largest possible distance, if known. Infinity if not known. Determines whether to use linear function or hyperbolic squashing function to map distance to resulting value.

---

The documentation for this class was generated from the following files:

• descriptor.h
• Comparison.cc

---