Interface SMNumericSigmoid
-
- All Superinterfaces:
SimilarityMeasure
,SMNumeric
- All Known Implementing Classes:
SMNumericSigmoidImpl
public interface SMNumericSigmoid extends SMNumeric
We can also use sigmoid functions as a generalization of threshold functions. The parameter $\theta \geq 0$ specifies the difference value at which the similarity has a value of $0.5$. The parameter $\alpha>0$ specifies the steepness of the similarity decrease: the smaller $\alpha$ the steeper is the decrease.
-
-
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 Modifier and Type Field Description static double
DEFAULT_ALPHA
The default alpha value is 1.0.static double
DEFAULT_THETA
The default theta value is 1.0.static String
NAME
Name of similarity measure is "NumericSigmoid".-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description double
getAlpha()
double
getTheta()
void
setAlpha(double alpha)
Alpha is necessary for sigmoid function.void
setTheta(double theta)
Theta is necessary for the sigmoid function.-
Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure
compute, getDataClass, getName, getSystemName, isForceOverride, isReusable, setForceOverride
-
Methods inherited from interface de.uni_trier.wi2.procake.similarity.base.numeric.SMNumeric
getAsymmetricStrategy, getOrderName, removeOrder, setAsymmetricStrategy, setOrderName
-
-
-
-
Field Detail
-
NAME
static final String NAME
Name of similarity measure is "NumericSigmoid".- See Also:
- Constant Field Values
-
DEFAULT_ALPHA
static final double DEFAULT_ALPHA
The default alpha value is 1.0.- See Also:
- Constant Field Values
-
DEFAULT_THETA
static final double DEFAULT_THETA
The default theta value is 1.0.- See Also:
- Constant Field Values
-
-
Method Detail
-
getAlpha
double getAlpha()
-
setAlpha
void setAlpha(double alpha)
Alpha is necessary for sigmoid function. Alpha should be very small, e.g., 0.1 or 0.01.- Parameters:
alpha
- must be greater zero
-
getTheta
double getTheta()
-
setTheta
void setTheta(double theta)
Theta is necessary for the sigmoid function. Theta must be between 0 an 1.- Parameters:
theta
- must be greater zero
-
-