org.grouplens.lenskit.iterative

Class ThresholdStoppingCondition

java.lang.Object

org.grouplens.lenskit.iterative.ThresholdStoppingCondition

All Implemented Interfaces:

Serializable, StoppingCondition

@Immutable
 @Shareable
public class ThresholdStoppingCondition
extends Object
implements StoppingCondition, Serializable

Stop when absolute delta drops below a threshold.

Since:

0.11

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThresholdStoppingCondition(double thresh) Create a new threshold stop with no minimum iteration count.
ThresholdStoppingCondition(double thresh, int minIter) Construct a new threshold stop.

Method Summary

Modifier and Type	Method and Description
int	getMinimumIterations() Get the minimum iteration count.
double	getThreshold() Get the stopper's threshold.
TrainingLoopController	newLoop() Create a controller for a new training loop.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ThresholdStoppingCondition

@Inject
public ThresholdStoppingCondition(@StoppingThreshold
                                          double thresh,
                                          @MinimumIterations
                                          int minIter)

Construct a new threshold stop.

Parameters:

thresh - The threshold.

minIter - The minimum number of iterations.

ThresholdStoppingCondition

public ThresholdStoppingCondition(double thresh)

Create a new threshold stop with no minimum iteration count.

Parameters:

thresh - The threshold value.

Method Detail

newLoop

public TrainingLoopController newLoop()

Description copied from interface: StoppingCondition

Create a controller for a new training loop.

Specified by:

newLoop in interface StoppingCondition

Returns:

A loop controller for a new iterative update loop.

getThreshold

public double getThreshold()

Get the stopper's threshold.

Returns:

The stopper's threshold.

getMinimumIterations

public int getMinimumIterations()

Get the minimum iteration count.

Returns:

The number of iterations to require.

toString

public String toString()

Overrides:

toString in class Object