WeightFunction (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

All Known Implementing Classes:

ConstantWeight, ErfcStddevWeight, ErfcWeight, ExponentialStddevWeight, ExponentialWeight, GaussStddevWeight, GaussWeight, InverseLinearWeight, InverseProportionalStddevWeight, InverseProportionalWeight, LinearWeight, QuadraticStddevWeight, QuadraticWeight
```
public interface WeightFunction
```
WeightFunction interface that allows the use of various distance-based weight functions. In addition to the distance parameter, the maximum distance and standard deviation are also given, to allow distance functions to be normalized according to the maximum or standard deviation.

Since:

0.2

Author:

Erich Schubert

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`double`	`getWeight(double distance, double max, double stddev)`	Evaluate weight function with given parameters.

- Method Detail
  - getWeight
```
double getWeight(double distance,
                 double max,
                 double stddev)
```
    Evaluate weight function with given parameters.
    Note that usually implementations will ignore either max or stddev.
    
    Parameters:
    
    distance - distance of the query point
    
    max - maximum distance of all included points
    
    stddev - standard deviation (i.e. quadratic mean / RMS) of the included points
    
    Returns:
    
    weight for the query point