Interface IDistance<T, U>

Common interface for distance functions (not necessarily metrics).

Namespace: ISynergy.Framework.Mathematics.Distances.Base

Assembly: ISynergy.Framework.Mathematics.dll

Syntax

public interface IDistance<in T, in U>

Type Parameters

Name	Description
T	The type of the first element to be compared.
U	The type of the second element to be compared.

Remarks

The framework distinguishes between metrics and distances by using different types for them. This makes it possible to let the compiler figure out logic problems such as the specification of a non-metric for a method that requires a proper metric (i.e. that respects the triangle inequality).

The objective of this technique is to make it harder to make some mistakes. However, it is generally possible to bypass this mechanism by using named constructors available at each of the classes, such as Minkowski's Nonmetric(Double) method, to create distances implementing the IMetric<T> interface that are not really metrics. Use at your own risk.

Methods

View Source

Distance(T, U)

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

Declaration

double Distance(T x, U y)

Parameters

Type	Name	Description
T	x	The first point `x`.
U	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.