com.chemaxon.descriptors.common.binary

Class BinaryVectorDescriptorComparator

java.lang.Object

com.chemaxon.descriptors.common.binary.BinaryVectorDescriptorComparator

All Implemented Interfaces:

DescriptorComparator<BinaryVectorDescriptor>, Guarded, Serializable

public class BinaryVectorDescriptorComparator
extends Object
implements DescriptorComparator<BinaryVectorDescriptor>

DescriptorComparator for binary vectors.

See Also:

Serialized Form

Nested Class Summary

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

Guarded.EnsureThat, Guarded.New

Constructor Summary

Constructors

Constructor and Description
BinaryVectorDescriptorComparator(DescriptorSerializer<BinaryVectorDescriptor> descriptorSerializer, BinaryVectorComparator comparator, int size, UnguardedContext<BinaryVectorDescriptor,?> unguardedContext) Create an instance.

Method Summary

Modifier and Type	Method and Description
double	calculateDissimilarity(BinaryVectorDescriptor target, BinaryVectorDescriptor query) Compare two descriptors.
double	calculateDissimilarity(byte[] target, byte[] query) Compare two descriptors in serialized form.
double	calculateSimilarity(BinaryVectorDescriptor target, BinaryVectorDescriptor query) Compare two descriptors.
double	calculateSimilarity(byte[] target, byte[] query) Compare two descriptors in serialized form.
ComparisonResult	compare(BinaryVectorDescriptor target, BinaryVectorDescriptor query) Compare two descriptors.
ComparisonResult	compare(byte[] target, byte[] query) Compare two descriptors in serialized form.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
Optional<Double>	getLowerBound() Get lower bound for the similarity/dissimilarity values if such one can be determined.
MetricMetadata	getMetricMetadata() Metadata about this metric.
Optional<Double>	getUpperBound() Get upper bound for the similarity/dissimilarity values if such one can be determined.
String	toString()
UnguardedContext<BinaryVectorDescriptor,?>	unguardedContext() Associated unguarded context.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryVectorDescriptorComparator

public BinaryVectorDescriptorComparator(DescriptorSerializer<BinaryVectorDescriptor> descriptorSerializer,
                                        BinaryVectorComparator comparator,
                                        int size,
                                        UnguardedContext<BinaryVectorDescriptor,?> unguardedContext)

Create an instance.

Parameters:

descriptorSerializer - Underlying serializer, also source of the guard object

comparator - Underlying comparator.

size - Vector length.

unguardedContext - Associated unguarded context

Method Detail

compare

public ComparisonResult compare(BinaryVectorDescriptor target,
                                BinaryVectorDescriptor query)

Description copied from interface: DescriptorComparator

Compare two descriptors.

Please note that some implementation might return a result object containing additional data related to the compariosn results.

Specified by:

compare in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor

query - Query descriptor

Returns:

Comparison result wrapper

compare

public ComparisonResult compare(byte[] target,
                                byte[] query)

Description copied from interface: DescriptorComparator

Compare two descriptors in serialized form.

Please note that some implementation might return a result object containing additional data related to the compariosn results. This method's functionality is equivalent to comparing (with DescriptorComparator.compare(com.chemaxon.descriptors.common.Descriptor, com.chemaxon.descriptors.common.Descriptor)) deserialized (by DescriptorSerializer.fromByteArray(byte[])) descriptors.

Specified by:

compare in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor in its serialized form

query - Query descriptor in its serialized form

Returns:

Comparison result wrapper

calculateSimilarity

public double calculateSimilarity(BinaryVectorDescriptor target,
                                  BinaryVectorDescriptor query)

Description copied from interface: DescriptorComparator

Compare two descriptors.

Please note that this convenience method wraps ComparisonResult.getSimilarity() of comparison result constructed by DescriptorComparator.compare(com.chemaxon.descriptors.common.Descriptor, com.chemaxon.descriptors.common.Descriptor)

Specified by:

calculateSimilarity in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor

query - Query descriptor

Returns:

Similarity result

calculateDissimilarity

public double calculateDissimilarity(BinaryVectorDescriptor target,
                                     BinaryVectorDescriptor query)

Description copied from interface: DescriptorComparator

Compare two descriptors.

Please note that this convenience method wraps ComparisonResult.getDissimilarity() of comparison result constructed by DescriptorComparator.compare(com.chemaxon.descriptors.common.Descriptor, com.chemaxon.descriptors.common.Descriptor)

Specified by:

calculateDissimilarity in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor

query - Query descriptor

Returns:

Dissimilarity result

calculateSimilarity

public double calculateSimilarity(byte[] target,
                                  byte[] query)

Description copied from interface: DescriptorComparator

Compare two descriptors in serialized form.

Specified by:

calculateSimilarity in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor in its serialized form

query - Query descriptor in its serialized form

Returns:

Similarity result

calculateDissimilarity

public double calculateDissimilarity(byte[] target,
                                     byte[] query)

Description copied from interface: DescriptorComparator

Compare two descriptors in serialized form.

Specified by:

calculateDissimilarity in interface DescriptorComparator<BinaryVectorDescriptor>

Parameters:

target - Target descriptor in its serialized form

query - Query descriptor in its serialized form

Returns:

Dissimilarity result

getLowerBound

public Optional<Double> getLowerBound()

Description copied from interface: DescriptorComparator

Get lower bound for the similarity/dissimilarity values if such one can be determined.

Specified by:

getLowerBound in interface DescriptorComparator<BinaryVectorDescriptor>

Returns:

Lower bond if exists; otherwise absent

getUpperBound

public Optional<Double> getUpperBound()

Description copied from interface: DescriptorComparator

Get upper bound for the similarity/dissimilarity values if such one can be determined.

Specified by:

getUpperBound in interface DescriptorComparator<BinaryVectorDescriptor>

Returns:

Upper bond if exists; otherwise absent

getMetricMetadata

public MetricMetadata getMetricMetadata()

Description copied from interface: DescriptorComparator

Metadata about this metric.

It is guaranteed that the actual instance returned can be used as a parameter of the appropriate comparator getter method of the associated DescriptorGenerator

Specified by:

getMetricMetadata in interface DescriptorComparator<BinaryVectorDescriptor>

Returns:

Metadata of the comparison

toString

public String toString()

Overrides:

toString in class 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.

unguardedContext

public UnguardedContext<BinaryVectorDescriptor,?> unguardedContext()

Description copied from interface: DescriptorComparator

Associated unguarded context.

Specified by:

unguardedContext in interface DescriptorComparator<BinaryVectorDescriptor>

Returns:

unguarded context