com.chemaxon.descriptors.metrics

Interface MetricFactory<C>

Type Parameters:

C - Represented comparator/dissimilarity calculator type.

All Superinterfaces:

Serializable

All Known Subinterfaces:

BinaryVectorComparisonContextFactory<T>, BinaryVectorMetricFactory<C>, BvGenerator, CfpGenerator, ComparisonContextFactory<DC,D,T>, EcfpGenerator, FloatVectorComparisonContextFactory, FloatVectorMetricFactory<C>, FvGenerator, MaccsGenerator, PfGenerator, ScaledFvDescriptorGenerator

All Known Implementing Classes:

BinaryLongComparisonContextFactory, BvGeneratorImpl, FloatsComparisonContextFactory, FvGeneratorImpl, ScaledBytesFvComparisonContextFactory, ScaledShortsFvCoparisonContextFactory, SerializingComparisonContextFactory

@Beta
 @PublicAPI
public interface MetricFactory<C>
extends Serializable

Represents available metrics. Descriptor specific extensions are expected to provide additional comparator methods. Metric factory interfaces are referenced by ComparisonContextFactory.metricFactoryClass(). Metric factory interfaces must be annotated with Description.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricFactory.ToLinenote<C> Utility for creating a default linenote.

Method Summary

Modifier and Type	Method and Description
Linenote<C>	comparisonLinenote() Gets the string based parameterization description.
C	defaultComparison() Gets the default comparator object.

Method Detail

defaultComparison

C defaultComparison()

Gets the default comparator object.

Returns:

default comparator

comparisonLinenote

Linenote<C> comparisonLinenote()

Gets the string based parameterization description. This can be used to automatically compose user interfaces with rich parameterization. Please note that the represented APIs are under development.

Returns:

Parameterization description