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

Class SMNumericExponentialImpl

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.SMNumericExponentialImpl

All Implemented Interfaces:

SMNumeric, SMNumericExponential, SimilarityMeasure

public class SMNumericExponentialImpl
extends SMNumericImpl
implements SMNumericExponential

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.SMNumericExponential

DEFAULT_ALPHA, NAME

Constructor Summary

Constructors

Constructor	Description
SMNumericExponentialImpl()

Method Summary

Modifier and Type	Method	Description
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)	f(d) = e^{d \cdot -\alpha}
double	getAlpha()	Alpha should be greater 1, e.g., 5.
String	getSystemName()	The system name can be used to distinguish the similarity measures.
void	setAlpha(double alpha)	Alpha is necessary for exponential 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

SMNumericExponentialImpl

public SMNumericExponentialImpl()

Method Detail

compute

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

 f(d) = e^{d \cdot -\alpha}
 

Specified by:

compute in interface SimilarityMeasure

Parameters:

queryObject -

caseObject -

Returns:

a similarity value

See Also:

SimilarityMeasure.compute(DataObject, DataObject, SimilarityValuator)

getAlpha

public double getAlpha()

Description copied from interface: SMNumericExponential

Alpha should be greater 1, e.g., 5.

Specified by:

getAlpha in interface SMNumericExponential

Returns:

the alpha value

setAlpha

public void setAlpha(double alpha)

Description copied from interface: SMNumericExponential

Alpha is necessary for exponential function

Specified by:

setAlpha in interface SMNumericExponential

Parameters:

alpha - must be greater zero

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.