Interface BinaryVectorMetricFactory<C>

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.
  • Method Details

    • 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