net.sourceforge.cilib.stoppingcondition
Class MaximumIterations

java.lang.Object
  net.sourceforge.cilib.stoppingcondition.MaximumIterations

All Implemented Interfaces:

Serializable, StoppingCondition, Cloneable

public class MaximumIterations
extends Object
implements StoppingCondition

Author:

Edwin Peer

See Also:

Serialized Form

Field Summary

Fields inherited from interface net.sourceforge.cilib.stoppingcondition.StoppingCondition

CICLOPS_EXCLUDE_ALGORITHM

Constructor Summary

MaximumIterations()
Creates a new instance of MaximumIterations.

MaximumIterations(int maximumIterations)
Create an instance, with the given number of iterations.

MaximumIterations(MaximumIterations copy)
Copy constructor.

Method Summary

MaximumIterations	getClone() Create a cloned copy of the current object and return it.
int	getMaximumIterations() Get the maximum iteration count.
double	getPercentageCompleted() Determines the percentage complete for the associated algorithm.
boolean	isCompleted() Determines whether the stopping condition has been satisfied (equivalent to StoppingCondition.getPercentageCompleted() == 1.0 but may be more efficient).
void	setAlgorithm(Algorithm algorithm) Sets the algorithm that this stopping condition should be applied to.
void	setMaximumIterations(int maximumIterations) Set the maximum number of iterations.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaximumIterations

public MaximumIterations()

Creates a new instance of MaximumIterations.

MaximumIterations

public MaximumIterations(MaximumIterations copy)

Copy constructor. Creates a copy of the given instance.

Parameters:

copy - The instance to copy.

MaximumIterations

public MaximumIterations(int maximumIterations)

Create an instance, with the given number of iterations.

Parameters:

maximumIterations - The maximum number of iterations.

Method Detail

getClone

public MaximumIterations getClone()

Create a cloned copy of the current object and return it. In general the created copy will be a deep copy of the provided instance. As a result this operation an be quite expensive if used incorrectly.

Specified by:

getClone in interface StoppingCondition

Specified by:

getClone in interface Cloneable

Returns:

An exact clone of the current object instance.

See Also:

Object.clone()

getMaximumIterations

public int getMaximumIterations()

Get the maximum iteration count.

Returns:

The maximum iterations.

setMaximumIterations

public void setMaximumIterations(int maximumIterations)

Set the maximum number of iterations.

Parameters:

maximumIterations - The value to set.

getPercentageCompleted

public double getPercentageCompleted()

Determines the percentage complete for the associated algorithm.

Specified by:

getPercentageCompleted in interface StoppingCondition

isCompleted

public boolean isCompleted()

Determines whether the stopping condition has been satisfied (equivalent to StoppingCondition.getPercentageCompleted() == 1.0 but may be more efficient).

Specified by:

isCompleted in interface StoppingCondition

Returns:

true when condition is satisfied, false otherwise

setAlgorithm

public void setAlgorithm(Algorithm algorithm)

Sets the algorithm that this stopping condition should be applied to. Called by Algorithm.addStoppingCondition(StoppingCondition). This ensures that any down casting necessary is done only once, when the stopping codition is added to an alogorithm (as apposed to after each iteration).

Specified by:

setAlgorithm in interface StoppingCondition

Parameters:

algorithm - The applicable Algorithm.