Package de.uni_trier.wi2.procake.similarity.base.numeric.impl

Class SMNumericThresholdImpl

java.lang.Object

de.uni_trier.wi2.procake.similarity.impl.SimilarityMeasureImpl

de.uni_trier.wi2.procake.similarity.base.numeric.impl.SMNumericImpl

de.uni_trier.wi2.procake.similarity.base.numeric.impl.SMNumericThresholdImpl

All Implemented Interfaces:

SMNumeric, SMNumericThreshold, SimilarityMeasure

public class SMNumericThresholdImpl
extends SMNumericImpl
implements SMNumericThreshold

Author:

rmaximi

Nested Class Summary

Nested classes/interfaces inherited from interface de.uni_trier.wi2.procake.similarity.base.numeric.SMNumeric

SMNumeric.ZERO_OUT_STRATEGIES

Field Summary

Fields inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure

COMPONENT, COMPONENT_KEY, LOG_ORDER_NAME_NOT_FOUND

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.numeric.SMNumeric

DEFAULT_STRATEGY

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.numeric.SMNumericThreshold

DEFAULT_THRESHOLD, NAME

Constructor Summary

Constructors

Constructor	Description
SMNumericThresholdImpl()

Method Summary

Modifier and Type	Method	Description
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)	f(d) = \left\{ \begin{array}{r@{\quad:\quad}l} 1 & d < \theta \\ 0 & d \geq \theta \\ \end{array} \right.
String	getSystemName()	The system name can be used to distinguish the similarity measures.
double	getThreshold()
void	setThreshold(double theta)	Theta is necessary for the sigmoid function and as threshold for the threshold function

Methods inherited from class de.uni_trier.wi2.procake.similarity.base.numeric.impl.SMNumericImpl

applyAsymmetricSituation, getAsymmetricStrategy, getAtomicClass, isSimilarityFor, setAsymmetricStrategy

Methods inherited from class de.uni_trier.wi2.procake.similarity.impl.SimilarityMeasureImpl

getDataClass, getName, initialize, initializeBasedOn, isAggregate, isForceOverride, isInterval, isNumeric, isObject, isReusable, isSet, isTable, isTaxonomy, isText, setDataClass, setForceOverride, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure

getDataClass, getName, isForceOverride, isReusable, setForceOverride

Methods inherited from interface de.uni_trier.wi2.procake.similarity.base.numeric.SMNumeric

getAsymmetricStrategy, setAsymmetricStrategy

Constructor Detail

SMNumericThresholdImpl

public SMNumericThresholdImpl()

Method Detail

compute

public Similarity compute(DataObject queryObject,
                          DataObject caseObject,
                          SimilarityValuator valuator)

 f(d) = \left\{ \begin{array}{r@{\quad:\quad}l}
                     1 & d < \theta \\
                      0 & d \geq \theta \\
                 \end{array} \right.
 

Specified by:

compute in interface SimilarityMeasure

Parameters:

queryObject -

caseObject -

Returns:

a similarity value

getSystemName

public String getSystemName()

Description copied from interface: SimilarityMeasure

The system name can be used to distinguish the similarity measures. Each similarity measure that can be instantiated contains a static final field called NAME representing the system name, e.g., SMAggregateEuclidian.NAME

The system name must also be given during initialization, see SimilarityModel.createSimilarityMeasure(String, DataClass).

Specified by:

getSystemName in interface SimilarityMeasure

Returns:

The system name of the similarity measure. This is equal to SimilarityMeasure.NAME.

getThreshold

public double getThreshold()

Specified by:

getThreshold in interface SMNumericThreshold

setThreshold

public void setThreshold(double theta)

Description copied from interface: SMNumericThreshold

Theta is necessary for the sigmoid function and as threshold for the threshold function

Specified by:

setThreshold in interface SMNumericThreshold

Parameters:

theta - must be greater zero