com.chemaxon.descriptors.alignment.drshape

Class DRShapeHistogramComparator

java.lang.Object

com.chemaxon.descriptors.alignment.AbstractShapeComparator<DRShapeDescriptor>

com.chemaxon.descriptors.alignment.drshape.DRShapeHistogramComparator

All Implemented Interfaces:

ShapeComparator<DRShapeDescriptor>, DescriptorComparator<DRShapeDescriptor>, Guarded, Serializable

public final class DRShapeHistogramComparator
extends AbstractShapeComparator<DRShapeDescriptor>

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
DRShapeHistogramComparator(DRShapeGenerator generator, DRShapeComparatorParameter comparatorParameter)

Method Summary

Modifier and Type	Method and Description
ShapeComparisonResult	compare(DRShapeDescriptor target, DRShapeDescriptor query) Compare two descriptors.
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()

Methods inherited from class com.chemaxon.descriptors.alignment.AbstractShapeComparator

calculateDissimilarity, calculateDissimilarity, calculateSimilarity, calculateSimilarity, compare, getGuardObject, getLowerBound, unguardedContext

Methods inherited from class java.lang.Object

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

Constructor Detail

DRShapeHistogramComparator

public DRShapeHistogramComparator(DRShapeGenerator generator,
                                  DRShapeComparatorParameter comparatorParameter)

Method Detail

compare

public ShapeComparisonResult compare(DRShapeDescriptor target,
                                     DRShapeDescriptor 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.

Parameters:

target - Target descriptor

query - Query descriptor

Returns:

Comparison result wrapper

getUpperBound

public Optional<Double> getUpperBound()

Description copied from interface: DescriptorComparator

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

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

Returns:

Metadata of the comparison

toString

public String toString()

Overrides:

toString in class Object