com.rapidminer.tools.math.similarity.nominal
Class AbstractNominalSimilarity

java.lang.Object
  com.rapidminer.tools.math.similarity.DistanceMeasure
      com.rapidminer.tools.math.similarity.SimilarityMeasure
          com.rapidminer.tools.math.similarity.nominal.AbstractNominalSimilarity

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DiceNominalSimilarity, JaccardNominalSimilarity, KulczynskiNominalSimilarity, RogersTanimotoNominalSimilarity, RussellRaoNominalSimilarity, SimpleMatchingNominalSimilarity

public abstract class AbstractNominalSimilarity
extends SimilarityMeasure

This is the abstract superclass for all nominal similarity measures.

Author:

Sebastian Land

See Also:

Serialized Form

Constructor Summary

AbstractNominalSimilarity()

Method Summary

double	calculateDistance(double[] value1, double[] value2) This method does the calculation of the distance between two double arrays.
double	calculateSimilarity(double[] value1, double[] value2) This method does the similarity of the distance between two double arrays.
protected abstract double	calculateSimilarity(double equalNonFalseValues, double unequalValues, double falseValues) Calculate a similarity given the number of attributes for which both examples agree/disagree.
void	init(ExampleSet exampleSet) Before using a similarity measure, it is needed to initialise.

Methods inherited from class com.rapidminer.tools.math.similarity.SimilarityMeasure

isDistance

Methods inherited from class com.rapidminer.tools.math.similarity.DistanceMeasure

calculateDistance, calculateDistance, calculateSimilarity, calculateSimilarity, init, init, isSimilarity

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNominalSimilarity

public AbstractNominalSimilarity()

Method Detail

calculateDistance

public double calculateDistance(double[] value1,
                                double[] value2)

Description copied from class: DistanceMeasure

This method does the calculation of the distance between two double arrays. The meanings of the double values might be remembered from the init method.

Specified by:

calculateDistance in class DistanceMeasure

Returns:

the distance

calculateSimilarity

public double calculateSimilarity(double[] value1,
                                  double[] value2)

Description copied from class: DistanceMeasure

This method does the similarity of the distance between two double arrays. The meanings of the double values might be remembered from the init method.

Specified by:

calculateSimilarity in class DistanceMeasure

Returns:

the distance

calculateSimilarity

protected abstract double calculateSimilarity(double equalNonFalseValues,
                                              double unequalValues,
                                              double falseValues)

Calculate a similarity given the number of attributes for which both examples agree/disagree.

Parameters:

equalNonFalseValues - the number of attributes for which both examples are equal and non-zero

unequalValues - the number of attributes for which both examples have unequal values

falseValues - the number of attributes for which both examples have zero values

Returns:

the similarity

init

public void init(ExampleSet exampleSet)
          throws OperatorException

Description copied from class: DistanceMeasure

Before using a similarity measure, it is needed to initialise. Subclasses might use initialising for remembering the exampleset properties like attribute type or test if applicable to exampleSet at all. Please note that it might be necessary to also override the other init methods if this measrue should make use of parameters or other IOObjects.

Specified by:

init in class DistanceMeasure

Parameters:

exampleSet - the exampleset

Throws:

OperatorException