org.grouplens.lenskit.iterative

Class IterationCountStoppingCondition

java.lang.Object

org.grouplens.lenskit.iterative.IterationCountStoppingCondition

All Implemented Interfaces:

Serializable, StoppingCondition

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

Stop once the iteration count has reached a value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IterationCountStoppingCondition(int niter) Construct a new iteration count stopping condition.

Method Summary

Modifier and Type	Method and Description
int	getIterationCount() Get the number of iterations the stopper requires.
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

IterationCountStoppingCondition

@Inject
public IterationCountStoppingCondition(@IterationCount
                                                int niter)

Construct a new iteration count stopping condition.

Parameters:

niter - The number of iterations to run.

Method Detail

getIterationCount

public int getIterationCount()

Get the number of iterations the stopper requires.

Returns:

The number of iterations.

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.

toString

public String toString()

Overrides:

toString in class Object