com.chemaxon.descriptors.common.comparison.impl

Class ScaledShortsFvCoparisonContextFactory

java.lang.Object

com.chemaxon.descriptors.common.comparison.impl.ScaledShortsFvCoparisonContextFactory

All Implemented Interfaces:

ComparisonContextFactory<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>, FloatVectorComparisonContextFactory, Guarded, FloatVectorMetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>, MetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>, Serializable

public class ScaledShortsFvCoparisonContextFactory
extends Object
implements FloatVectorComparisonContextFactory

Comparison context factory for scaled shorts backed float vector descriptors. Note that type of unguarded representation depends on the descriptor parameters (byte[] or short[]). It is expected to pass only instances of ScaledBytesFloatVectorDescriptorImpl.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.common.Guarded

Guarded.EnsureThat, Guarded.New

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.metrics.FloatVectorMetricFactory

FloatVectorMetricFactory.ToLinenote<C>

Constructor Summary

Constructors

Constructor and Description
ScaledShortsFvCoparisonContextFactory(LinearScaler scaler, int length, DescriptorSerializer<FloatVectorDescriptor> serializer) Instantiate.

Method Summary

Modifier and Type	Method and Description
Linenote<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>	comparisonLinenote() Gets the string based parameterization description.
ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>	defaultComparison() Gets the default comparator object.
DescriptorSerializer<FloatVectorDescriptor>	descriptorSerializer() Associated descriptor serializer.
ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>	forFloatMetrics(FloatVectorMetrics metric) Creates a new Comparator instance according to the given metric.
ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>	forTversky(TverskyParameters parameters) Creates a new Comparator instance according to the given Tversky metric parameters.
ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>	forTverskyCoefficients(double coeffQuery, double coeffTarget) Creates a new Comparator instance according to the given Tversky metric parameters.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
Class<? extends MetricFactory>	metricFactoryClass() Represented metric factory class.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScaledShortsFvCoparisonContextFactory

public ScaledShortsFvCoparisonContextFactory(LinearScaler scaler,
                                             int length,
                                             DescriptorSerializer<FloatVectorDescriptor> serializer)

Instantiate.

Parameters:

scaler - Scaler to expose for unguarded comparators

length - Dimensionality

serializer - Descriptor serializer; also source of guard object

Method Detail

metricFactoryClass

public Class<? extends MetricFactory> metricFactoryClass()

Description copied from interface: ComparisonContextFactory

Represented metric factory class. The represented metric factory interface is expected to have a Description annotation.

Specified by:

metricFactoryClass in interface ComparisonContextFactory<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>

Returns:

Represented metric factory

defaultComparison

public ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable> defaultComparison()

Description copied from interface: MetricFactory

Gets the default comparator object.

Specified by:

defaultComparison in interface MetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>

Returns:

default comparator

forFloatMetrics

public ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable> forFloatMetrics(FloatVectorMetrics metric)

Description copied from interface: FloatVectorMetricFactory

Creates a new Comparator instance according to the given metric.

Specified by:

forFloatMetrics in interface FloatVectorMetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>

Parameters:

metric - binary metric

Returns:

a comparator object

forTverskyCoefficients

public ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable> forTverskyCoefficients(double coeffQuery,
                                                                                                                                double coeffTarget)

Description copied from interface: FloatVectorMetricFactory

Creates a new Comparator instance according to the given Tversky metric parameters.

Specified by:

forTverskyCoefficients in interface FloatVectorMetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>

Parameters:

coeffQuery - Query side coefficient

coeffTarget - Target side coefficient

Returns:

a comparator object

toString

public String toString()

Overrides:

toString in class Object

forTversky

public ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable> forTversky(TverskyParameters parameters)

Description copied from interface: FloatVectorMetricFactory

Creates a new Comparator instance according to the given Tversky metric parameters.

Specified by:

forTversky in interface FloatVectorMetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>

Parameters:

parameters - parameters for the comparator

Returns:

a comparator object

getGuardObject

public Object getGuardObject()

Description copied from interface: Guarded

Gets the guard object associated to the generated descriptors/utilities. Note that serialization/deserialization must preserve guard object reference.

This method is intended to use only for ensuring the compatibility of manipulated objects.

Implementations might use the associated DescriptorGenerator or DescriptorParameters reference as the guard object, however it is a non recommended practice to use this method to access the associated generator to perform further operations on it.

Specified by:

getGuardObject in interface Guarded

Returns:

The guard object, can not be null.

descriptorSerializer

public DescriptorSerializer<FloatVectorDescriptor> descriptorSerializer()

Description copied from interface: ComparisonContextFactory

Associated descriptor serializer.

Specified by:

descriptorSerializer in interface ComparisonContextFactory<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>

Returns:

Descriptor serializer.

comparisonLinenote

public Linenote<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>> comparisonLinenote()

Description copied from interface: MetricFactory

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.

Specified by:

comparisonLinenote in interface MetricFactory<ComparisonContext<DescriptorComparator<FloatVectorDescriptor>,FloatVectorDescriptor,Serializable>>

Returns:

Parameterization description