org.grouplens.lenskit.transform.clamp

Class RatingRangeClampingFunction

java.lang.Object

org.grouplens.lenskit.transform.clamp.RatingRangeClampingFunction

All Implemented Interfaces:

Serializable, ClampingFunction

@Shareable
public class RatingRangeClampingFunction
extends Object
implements ClampingFunction, Serializable

Clamp values to the range of valid ratings. This clamping function uses the PreferenceDomain to clamp values to fall within the minimum and maximum allowable ratings.

Since:

0.11

Author:

GroupLens Research

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RatingRangeClampingFunction(PreferenceDomain dom)

Method Summary

Methods

Modifier and Type	Method and Description
double	apply(long user, long item, double value) Clamp a value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingRangeClampingFunction

@Inject
public RatingRangeClampingFunction(PreferenceDomain dom)

Method Detail

apply

public double apply(long user,
           long item,
           double value)

Description copied from interface: ClampingFunction

Clamp a value.

Specified by:

apply in interface ClampingFunction

Parameters:

user - The user ID.

item - The item ID.

value - The value to clamp.

Returns:

The clamped value.