com.rapidminer.tools.math.similarity.numerical
Class MaxProductSimilarity

java.lang.Object
  com.rapidminer.tools.math.similarity.DistanceMeasure
      com.rapidminer.tools.math.similarity.SimilarityMeasure
          com.rapidminer.tools.math.similarity.numerical.MaxProductSimilarity

All Implemented Interfaces:

java.io.Serializable

public class MaxProductSimilarity
extends SimilarityMeasure

Specialized similarity that takes the maximum product of two feature values. If this value is zero, the similarity is undefined. This similarity measure is used mainly with features extracted from cluster models.

Author:

Michael Wurst

See Also:

Serialized Form

Constructor Summary

MaxProductSimilarity()

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.
void	init(ExampleSet exampleSet) Before using a similarity measure, it is needed to initialize.
java.lang.String	toString()

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, installAdditionalPorts, isSimilarity, uninstallAdditionalPorts

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxProductSimilarity

public MaxProductSimilarity()

Method Detail

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

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

init

public void init(ExampleSet exampleSet)
          throws OperatorException

Description copied from class: DistanceMeasure

Before using a similarity measure, it is needed to initialize. Subclasses might use initializing 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 measure should make use of parameters or other IOObjects. Attention! Subclasses must call this super method to ensure correct initialization!

Overrides:

init in class DistanceMeasure

Parameters:

exampleSet - the exampleset

Throws:

OperatorException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object