Class Euclidean

Euclidean distance metric.

Inheritance

System.Object

Euclidean

Implements

IMetric<System.Double>

IDistance<System.Double>

IDistance<System.Double, System.Double>

ISimilarity<System.Double>

ISimilarity<System.Double, System.Double>

IMetric<System.Double[]>

IDistance<System.Double[]>

IDistance<System.Double[], System.Double[]>

ISimilarity<System.Double[]>

ISimilarity<System.Double[], System.Double[]>

IMetric<System.Tuple<System.Double, System.Double>>

IDistance<System.Tuple<System.Double, System.Double>>

IDistance<System.Tuple<System.Double, System.Double>, System.Tuple<System.Double, System.Double>>

ISimilarity<System.Tuple<System.Double, System.Double>>

ISimilarity<System.Tuple<System.Double, System.Double>, System.Tuple<System.Double, System.Double>>

IDistance<Sparse<System.Double>>

IDistance<Sparse<System.Double>, Sparse<System.Double>>

ISimilarity<Sparse<System.Double>>

ISimilarity<Sparse<System.Double>, Sparse<System.Double>>

System.ICloneable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Mars.Numerics.Distances

Assembly: Mars.Numerics.dll

Syntax

[Serializable]
public class Euclidean : IMetric<double>, IDistance<double>, IDistance<double, double>, ISimilarity<double>, ISimilarity<double, double>, IMetric<double[]>, IDistance<double[]>, IDistance<double[], double[]>, ISimilarity<double[]>, ISimilarity<double[], double[]>, IMetric<Tuple<double, double>>, IDistance<Tuple<double, double>>, IDistance<Tuple<double, double>, Tuple<double, double>>, ISimilarity<Tuple<double, double>>, ISimilarity<Tuple<double, double>, Tuple<double, double>>, IDistance<Sparse<double>>, IDistance<Sparse<double>, Sparse<double>>, ISimilarity<Sparse<double>>, ISimilarity<Sparse<double>, Sparse<double>>, ICloneable

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

See Also

SquareEuclidean

Distance(Sparse<Double>, Sparse<Double>)

Computes the distance d(x,y) between points x and y.

Declaration

public double Distance(Sparse<double> x, Sparse<double> y)

Parameters

Type	Name	Description
Sparse<System.Double>	x	The first point x.
Sparse<System.Double>	y	The second point y.

Returns

Type	Description
System.Double	A double-precision value representing the distance d(x,y) between x and y according to the distance function implemented by this class.

See Also

SquareEuclidean

Distance(Double, Double, Double, Double)

Gets the Euclidean distance between two points. Note: this function is dangerous as it is too easy to invert its arguments by mistake. Please consider using the Tuple<double, double> overload instead.

Declaration

public double Distance(double vector1X, double vector1Y, double vector2X, double vector2Y)

Parameters

Type	Name	Description
System.Double	vector1X	The first coordinate of first point in space.
System.Double	vector1Y	The second coordinate of first point in space.
System.Double	vector2X	The first coordinate of second point in space.
System.Double	vector2Y	The second coordinate of second point in space.

Returns

Type	Description
System.Double	The Euclidean distance between x and y.

See Also

SquareEuclidean

Distance(Double, Double)

Computes the distance d(x,y) between points x and y.

Declaration

public double Distance(double x, double y)

Parameters

Type	Name	Description
System.Double	x	The first point x.
System.Double	y	The second point y.

Returns

Type	Description
System.Double	A double-precision value representing the distance d(x,y) between x and y according to the distance function implemented by this class.

See Also

SquareEuclidean

Distance(Double[], Double[])

Computes the distance d(x,y) between points x and y.

Declaration

public double Distance(double[] x, double[] y)

Parameters

Type	Name	Description
System.Double[]	x	The first point x.
System.Double[]	y	The second point y.

Returns

Type	Description
System.Double	A double-precision value representing the distance d(x,y) between x and y according to the distance function implemented by this class.

See Also

SquareEuclidean

Distance(Tuple<Double, Double>, Tuple<Double, Double>)

Gets the Euclidean distance between two points.

Declaration

public double Distance(Tuple<double, double> x, Tuple<double, double> y)

Parameters

Type	Name	Description
System.Tuple<System.Double, System.Double>	x	The first point in space.
System.Tuple<System.Double, System.Double>	y	The second point in space.

Returns

Type	Description
System.Double	The Euclidean distance between x and y.

See Also

SquareEuclidean

Similarity(Sparse<Double>, Sparse<Double>)

Gets a similarity measure between two points.

Declaration

public double Similarity(Sparse<double> x, Sparse<double> y)

Parameters

Type	Name	Description
Sparse<System.Double>	x	The first point to be compared.
Sparse<System.Double>	y	The second point to be compared.

Returns

Type	Description
System.Double	A similarity measure between x and y.

See Also

SquareEuclidean

Similarity(Double, Double)

Gets a similarity measure between two points.

Declaration

public double Similarity(double x, double y)

Parameters

Type	Name	Description
System.Double	x	The first point to be compared.
System.Double	y	The second point to be compared.

Returns

Type	Description
System.Double	A similarity measure between x and y.

See Also

SquareEuclidean

Similarity(Double[], Double[])

Gets a similarity measure between two points.

Declaration

public double Similarity(double[] x, double[] y)

Parameters

Type	Name	Description
System.Double[]	x	The first point to be compared.
System.Double[]	y	The second point to be compared.

Returns

Type	Description
System.Double	A similarity measure between x and y.

See Also

SquareEuclidean

Similarity(Tuple<Double, Double>, Tuple<Double, Double>)

Gets a similarity measure between two points.

Declaration

public double Similarity(Tuple<double, double> x, Tuple<double, double> y)

Parameters

Type	Name	Description
System.Tuple<System.Double, System.Double>	x	The first point to be compared.
System.Tuple<System.Double, System.Double>	y	The second point to be compared.

Returns

Type	Description
System.Double	A similarity measure between x and y.

See Also

SquareEuclidean

Implements

IMetric<T>

IDistance<T>

IDistance<TFirst, TSecond>

ISimilarity<T>

ISimilarity<T, TU>

IMetric<T>

IDistance<T>

IDistance<TFirst, TSecond>

ISimilarity<T>

ISimilarity<T, TU>

IMetric<T>

IDistance<T>

IDistance<TFirst, TSecond>

ISimilarity<T>

ISimilarity<T, TU>

IDistance<T>

IDistance<TFirst, TSecond>

ISimilarity<T>

ISimilarity<T, TU>

System.ICloneable

Extension Methods

Serializer.Save<T>(T, out Byte[], SerializerCompression)

Serializer.Save<T>(T, Stream, SerializerCompression)

Serializer.Save<T>(T, BinaryFormatter, Stream, SerializerCompression)

Serializer.Save<T>(T, String, SerializerCompression)

Serializer.Save<T>(T, String)

Matrix.Concatenate<T>(T, T[])

Matrix.Replace<T>(T, Object, Object)

DomainDataImporter.Import(Object, InputConfiguration)

ObjectSerialize.Serialize(Object)

Matrix.IsEqual(Object, Object, Decimal, Decimal)

See Also

SquareEuclidean