com.chemaxon.descriptors.metrics

Interface MetricMetadata

All Superinterfaces:

Serializable

All Known Subinterfaces:

BinaryVectorComparator, FloatVectorComparator

All Known Implementing Classes:

BinaryMetrics, DRShapeMetrics, FloatVectorMetrics, ShapeMetrics, TverskyParameters

@Beta
 @PublicAPI
public interface MetricMetadata
extends Serializable

Metric Metadata contains info about a specific metric.

Please note that the word Metric here is used in the sense of way descriptors compared. Thus not all represented comparisons fulfill the definition of metric spaces (see isMetricSpace()).

The attributes described here refers to the properties of dissimilarity values.

Please note that this interface is marked with Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Method Summary

Modifier and Type	Method and Description
boolean	isDissimilarityZeroIFFEquals() Zero dissimilarity and identity.
boolean	isMetricSpace() Metric space.
boolean	isNonNegative() Non negativeness of the dissimilarity values.
boolean	isSymmetric() Symmetry.
boolean	isTriangeInequalityHolds() Triangle inequality.

Method Detail

isSymmetric

boolean isSymmetric()

Symmetry.

Returns:

true when d(x,y) = d(y,x)

See Also:

http://en.wikipedia.org/wiki/Metric_space

isNonNegative

boolean isNonNegative()

Non negativeness of the dissimilarity values.

Returns:

true when d(x,y) >= 0

See Also:

http://en.wikipedia.org/wiki/Metric_space

isDissimilarityZeroIFFEquals

boolean isDissimilarityZeroIFFEquals()

Zero dissimilarity and identity.

Returns:

true when dissimilarity is 0 for (and only for) identical descriptors

See Also:

http://en.wikipedia.org/wiki/Metric_space

isTriangeInequalityHolds

boolean isTriangeInequalityHolds()

Triangle inequality.

Returns:

true when d(x,z) <= d(x,y) + d( y,z)

See Also:

http://en.wikipedia.org/wiki/Metric_space

isMetricSpace

boolean isMetricSpace()

Metric space.

Returns:

If this comparator defines a metric space.

See Also:

http://en.wikipedia.org/wiki/Metric_space