org.grouplens.lenskit.transform.threshold

Class RealThreshold

java.lang.Object

org.grouplens.lenskit.transform.threshold.RealThreshold

All Implemented Interfaces:

java.io.Serializable, Threshold

@Shareable
public class RealThreshold
extends java.lang.Object
implements Threshold, java.io.Serializable

Checks similarity values to ensure their real values are over the ThresholdValue.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RealThreshold(double thresholdValue)

Method Summary

Modifier and Type	Method and Description
double	getValue() Get the threshold value.
boolean	retain(double sim) Checks a similarity value against retention criteria for inclusion in similarity models.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealThreshold

@Inject
public RealThreshold(@ThresholdValue
                             double thresholdValue)

Method Detail

getValue

public double getValue()

Get the threshold value.

Returns:

The threshold value.

retain

public boolean retain(double sim)

Description copied from interface: Threshold

Checks a similarity value against retention criteria for inclusion in similarity models.

Specified by:

retain in interface Threshold

Parameters:

sim - The double similarity value to check against the threshold.

Returns:

true if the parameter similarity value should be retained in the similarity model, false otherwise.