jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.descriptors.metrics
Interface BinaryVectorComparator

All Superinterfaces:
MetricMetadata, Serializable
All Known Implementing Classes:
BinaryMetrics, TverskyParameters

@Beta
public interface BinaryVectorComparator
extends MetricMetadata, Serializable

Basic functionality for finite binary vector based calculations.

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

Author:
Gabor Imre

Nested Class Summary
static class BinaryVectorComparator.Util
          Simple consistency check utility.
 
Method Summary
 double calculateBinaryVectorDissimilarity(int bitCount, int targetOnly, int queryOnly, int common)
          Calculate represented dissimilarity score from binary vector parameters.
 double calculateBinaryVectorSimilarity(int bitCount, int targetOnly, int queryOnly, int common)
          Calculate represented similarity score from binary vector parameters.
 double getLowerBoundForBinaryVectors(int bitCount)
          Possible lowest value of similarity/dissimilarity scores.
 double getUpperBoundForBinaryVectors(int bitCount)
          Possible highest value of similarity/dissimilarity scores.
 
Methods inherited from interface com.chemaxon.descriptors.metrics.MetricMetadata
isDissimilarityZeroIFFEquals, isMetricSpace, isNonNegative, isSymmetric, isTriangeInequalityHolds
 

Method Detail

calculateBinaryVectorDissimilarity

double calculateBinaryVectorDissimilarity(int bitCount,
                                          int targetOnly,
                                          int queryOnly,
                                          int common)
Calculate represented dissimilarity score from binary vector parameters.

Parameters:
bitCount - Length of binary vectors in bits
targetOnly - Number of bit positions where only target contains set bits
queryOnly - Number of bit positions where only query contains set bits
common - Number of bit positions where both query and target contains set bits
Returns:
Dissimilarity score

calculateBinaryVectorSimilarity

double calculateBinaryVectorSimilarity(int bitCount,
                                       int targetOnly,
                                       int queryOnly,
                                       int common)
Calculate represented similarity score from binary vector parameters.

Parameters:
bitCount - Length of binary vectors in bits
targetOnly - Number of bit positions where only target contains set bits
queryOnly - Number of bit positions where only query contains set bits
common - Number of bit positions where both query and target contains set bits
Returns:
Ssimilarity score

getLowerBoundForBinaryVectors

double getLowerBoundForBinaryVectors(int bitCount)
Possible lowest value of similarity/dissimilarity scores.

Parameters:
bitCount - Length of binary vectors in bits
Returns:
Possible lowest value of similarity/dissimilarity scores

getUpperBoundForBinaryVectors

double getUpperBoundForBinaryVectors(int bitCount)
Possible highest value of similarity/dissimilarity scores.

Parameters:
bitCount - Length of binary vectors in bits
Returns:
Possible highest value of similarity/dissimilarity scores

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)