org.openimaj.algorithm.iterative

Class MaxIterations

java.lang.Object

org.openimaj.algorithm.iterative.MaxIterations

All Implemented Interfaces:

Predicate<IterationState>

public class MaxIterations
extends Object
implements Predicate<IterationState>

Predicate for stopping iteration after a set maximum number of iterations. This predicate tests whether iteration should stop, so only returns true after the maximum number of iterations has been reached.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
MaxIterations(int maxIters) Construct with the given maximum number of iterations

Method Summary

Modifier and Type	Method and Description
boolean	test(IterationState is) Tests whether a specific object passes some criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxIterations

public MaxIterations(int maxIters)

Construct with the given maximum number of iterations

Parameters:

maxIters - maximum number of iterations

Method Detail

test

public boolean test(IterationState is)

Description copied from interface: Predicate

Tests whether a specific object passes some criteria.

Specified by:

test in interface Predicate<IterationState>

Parameters:

is - the object being tested.

Returns:

true if object passes the criteria; false otherwise.