org.grouplens.lenskit.iterative

Class ErrorThresholdStoppingCondition

java.lang.Object

org.grouplens.lenskit.iterative.ErrorThresholdStoppingCondition

All Implemented Interfaces:

Serializable, StoppingCondition

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

Stop when absolute value of the error drops below a threshold.

Note: Loop controllers created by this stopping condition support waiting until the threshold has been met for multiple iterations to stop.

This stopping condition differs from ThresholdStoppingCondition in that it thresholds the absolute error instead of the change in error from one iteration to another.

Since:

1.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorThresholdStoppingCondition(double thresh) Create a new threshold stop with no minimum iteration count.
ErrorThresholdStoppingCondition(double thresh, int minIter) Construct a new error 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

ErrorThresholdStoppingCondition

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

Construct a new error threshold stop.

Parameters:

thresh - The threshold.

minIter - The minimum number of iterations.

ErrorThresholdStoppingCondition

public ErrorThresholdStoppingCondition(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