SMNumeric (ProCAKE Framework 2.0.0 API)

All Superinterfaces:

SimilarityMeasure

All Known Subinterfaces:

SMNumericExponential, SMNumericFuzzy, SMNumericLinear, SMNumericSigmoid, SMNumericThreshold

All Known Implementing Classes:

SMNumericExponentialImpl, SMNumericFuzzyImpl, SMNumericImpl, SMNumericLinearImpl, SMNumericSigmoidImpl, SMNumericThresholdImpl
```
public interface SMNumeric
extends SimilarityMeasure
```
Abstract interface that collects all similarity measures for AtomicClass.
Numeric similarity measures can be used on several AtomicClass es. But therefore, it is important to specify an order so that the elements are totally ordered.

Author:

Rainer Maximini

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class SMNumeric.ZERO_OUT_STRATEGIES
Possible definitions of asymmetric zero-out strategies

Field Summary

Fields
Modifier and Type Field Description

static SMNumeric.ZERO_OUT_STRATEGIES DEFAULT_STRATEGY
Default strategy for numeric similarity computations is .
- Fields inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure
  COMPONENT, COMPONENT_KEY, LOG_ORDER_NAME_NOT_FOUND

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SMNumeric.ZERO_OUT_STRATEGIES`	`getAsymmetricStrategy()`	gets the asymmetric strategy
`String`	`getOrderName()`
`void`	`removeOrder()`	Similarity measure for numerics works also on the natural numeric order.
`void`	`setAsymmetricStrategy(SMNumeric.ZERO_OUT_STRATEGIES strategy)`	sets the asymmetric strategy
`void`	`setOrderName(String orderName)`	Specify the order name that should be used to calculate the distance between two values.

Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure
compute, getDataClass, getName, getSystemName, isForceOverride, isReusable, setForceOverride

- Field Detail
  - DEFAULT_STRATEGY
```
static final SMNumeric.ZERO_OUT_STRATEGIES DEFAULT_STRATEGY
```
    Default strategy for numeric similarity computations is .
- Method Detail
  - getOrderName
```
String getOrderName()
```
    Returns:
    
    The order name that is used.
  - setOrderName
```
void setOrderName(String orderName)
           throws NameNotFoundException
```
    Specify the order name that should be used to calculate the distance between two values.
    
    Parameters:
    
    orderName - The name of the order
    
    Throws:
    
    NameNotFoundException
    
    See Also:
    
    InstanceValueOrderPredicate
  - removeOrder
```
void removeOrder()
```
    Similarity measure for numerics works also on the natural numeric order. Therefore, it is possible to remove an already assigned order.
  - getAsymmetricStrategy
```
SMNumeric.ZERO_OUT_STRATEGIES getAsymmetricStrategy()
```
    gets the asymmetric strategy
    
    Returns:
  - setAsymmetricStrategy
```
void setAsymmetricStrategy(SMNumeric.ZERO_OUT_STRATEGIES strategy)
```
    sets the asymmetric strategy
    
    Parameters:
    
    strategy -