de.lmu.ifi.dbs.elki.distance.similarityfunction

Class Kulczynski1SimilarityFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

de.lmu.ifi.dbs.elki.distance.similarityfunction.Kulczynski1SimilarityFunction

All Implemented Interfaces:

PrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>, SimilarityFunction<NumberVector<?>,DoubleDistance>, Parameterizable

@Reference(authors="M.-M. Deza and E. Deza",
           title="Dictionary of distances",
           booktitle="Dictionary of distances")
public class Kulczynski1SimilarityFunction
extends AbstractPrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

Kulczynski similarity 1. Reference:

M.-M. Deza and E. Deza
Dictionary of distances

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kulczynski1SimilarityFunction.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
static Kulczynski1SimilarityFunction	STATIC Static instance.

Constructor Summary

Constructors

Constructor and Description
Kulczynski1SimilarityFunction() Deprecated. Use STATIC instance instead.

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleSimilarity(NumberVector<?> v1, NumberVector<?> v2) Compute the similarity.
DoubleDistance	getDistanceFactory() Get a distance factory.
SimpleTypeInformation<? super NumberVector<?>>	getInputTypeRestriction() Get the input data type of the function.
DoubleDistance	similarity(NumberVector<?> o1, NumberVector<?> o2) Computes the similarity between two given DatabaseObjects according to this similarity function.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPrimitiveSimilarityFunction

instantiate, isSymmetric

Methods inherited from class java.lang.Object

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

Field Detail

STATIC

public static final Kulczynski1SimilarityFunction STATIC

Static instance.

Constructor Detail

Kulczynski1SimilarityFunction

@Deprecated
public Kulczynski1SimilarityFunction()

Deprecated. Use STATIC instance instead.

Constructor.

Method Detail

getDistanceFactory

public DoubleDistance getDistanceFactory()

Description copied from interface: SimilarityFunction

Get a distance factory.

Returns:

distance factory

getInputTypeRestriction

public SimpleTypeInformation<? super NumberVector<?>> getInputTypeRestriction()

Description copied from interface: SimilarityFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface PrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

Specified by:

getInputTypeRestriction in interface SimilarityFunction<NumberVector<?>,DoubleDistance>

Specified by:

getInputTypeRestriction in class AbstractPrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

similarity

public DoubleDistance similarity(NumberVector<?> o1,
                        NumberVector<?> o2)

Description copied from interface: PrimitiveSimilarityFunction

Computes the similarity between two given DatabaseObjects according to this similarity function.

Specified by:

similarity in interface PrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

Specified by:

similarity in class AbstractPrimitiveSimilarityFunction<NumberVector<?>,DoubleDistance>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function

doubleSimilarity

public double doubleSimilarity(NumberVector<?> v1,
                      NumberVector<?> v2)

Compute the similarity.

Parameters:

v1 - First vector

v2 - Second vector

Returns:

Similarity