org.grouplens.lenskit.transform.threshold

Class AbsoluteThreshold

java.lang.Object

org.grouplens.lenskit.transform.threshold.AbsoluteThreshold

All Implemented Interfaces:

Serializable, Threshold

@Shareable
public class AbsoluteThreshold
extends Object
implements Threshold, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbsoluteThreshold(double threshold) Construct a new absolute-value threshold.

Method Summary

Modifier and Type	Method and Description
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

AbsoluteThreshold

@Inject
public AbsoluteThreshold(@ThresholdValue
                                  double threshold)

Construct a new absolute-value threshold.

Parameters:

threshold - The threshold valud.

Method Detail

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.