org.openimaj.algorithm.iterative

Class MinEpsilonOrMaxIterations

java.lang.Object

org.openimaj.util.function.predicates.Or<IterationState>

org.openimaj.algorithm.iterative.MinEpsilonOrMaxIterations

All Implemented Interfaces:

Predicate<IterationState>

public class MinEpsilonOrMaxIterations
extends Or<IterationState>

Convenience class that or's together the MinEpsilon and MaxIterations to produce a predicate that stops (returns true) as soon as either the minimum error is reached or the maximum number of iterations is exceeded.

Author:

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

Constructor Summary

Constructors

Constructor and Description
MinEpsilonOrMaxIterations(double epsilon, int maxIter) Construct with the given minimum epsilon and maximum number of iterations.

Method Summary

Methods inherited from class org.openimaj.util.function.predicates.Or

add, test

Methods inherited from class java.lang.Object

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

Constructor Detail

MinEpsilonOrMaxIterations

public MinEpsilonOrMaxIterations(double epsilon,
                                 int maxIter)

Construct with the given minimum epsilon and maximum number of iterations. Iterations will stop at whichever is reached first.

Parameters:

epsilon - the epsilon value below which iteration should stop

maxIter - maximum number of iterations