org.openimaj.algorithm.iterative

Class MinEpsilon

java.lang.Object

org.openimaj.algorithm.iterative.MinEpsilon

All Implemented Interfaces:

Predicate<IterationState>

public class MinEpsilon
extends Object
implements Predicate<IterationState>

Predicate for stopping iteration after a given threshold on epsilon is reached. 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
MinEpsilon(double minEps) Construct with the given minimum epsilon value is reached

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

MinEpsilon

public MinEpsilon(double minEps)

Construct with the given minimum epsilon value is reached

Parameters:

minEps - the epsilon value below which iteration should stop

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.