BinaryVectorMetricFactory (Marvin API documentation (c) 1998-2023 Chemaxon Ltd.)

Type Parameters:

C - Represented comparator/dissimilarity calculator type.
Please note that this interface is marked with Beta annotation, so it can be subject of incompatible changes or removal in later releases.

All Superinterfaces:

MetricFactory<C>, Serializable

All Known Subinterfaces:

BvGenerator, CfpGenerator, EcfpGenerator
```
@Beta
@PublicAPI
public interface BinaryVectorMetricFactory<C>
extends MetricFactory<C>
```
Represents available metrics for binary vector based descriptors.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class BinaryVectorMetricFactory.ToLinenote<C>
Utility for creating a default linenote.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`C`	`forBinaryMetrics(BinaryMetrics metrics)`	Creates a new instance according to the given metric.
`C`	`forTversky(TverskyParameters tverskyParamaters)`	Creates a new Comparator instance according to the given Tversky metric parameters.
`C`	`forTverskyCoefficients(double coeffQuery, double coeffTarget)`	Creates a new Comparator instance according to the given Tversky metric parameters.

Methods inherited from interface com.chemaxon.descriptors.metrics.MetricFactory
comparisonLinenote, defaultComparison

- Method Detail
  - forBinaryMetrics
```
C forBinaryMetrics(BinaryMetrics metrics)
```
    Creates a new instance according to the given metric.
    
    Parameters:
    
    metrics - binary metric
    
    Returns:
    
    a comparator object
  - forTversky
```
C forTversky(TverskyParameters tverskyParamaters)
```
    Creates a new Comparator instance according to the given Tversky metric parameters.
    
    Parameters:
    
    tverskyParamaters - parameters for the comparator
    
    Returns:
    
    a comparator object
  - forTverskyCoefficients
```
C forTverskyCoefficients(double coeffQuery,
                         double coeffTarget)
```
    Creates a new Comparator instance according to the given Tversky metric parameters.
    
    Parameters:
    
    coeffQuery - Query side coefficient
    
    coeffTarget - Target side coefficient
    
    Returns:
    
    a comparator object