net.sourceforge.cilib.stoppingcondition
Class MaximumRestarts

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

All Implemented Interfaces:

Serializable, StoppingCondition, Cloneable

public class MaximumRestarts
extends Object
implements StoppingCondition

The maximum number of allowed restarts.

Author:

Edwin Peer

See Also:

Serialized Form

Field Summary

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

CICLOPS_EXCLUDE_ALGORITHM

Constructor Summary

MaximumRestarts()
Creates a new instance of MaximumRestarts.

MaximumRestarts(int maximumRestarts)

MaximumRestarts(MaximumRestarts copy)

Method Summary

MaximumRestarts	getClone() Create a cloned copy of the current object and return it.
double	getPercentageCompleted() Determines the percentage complete for the associated algorithm.
int	getRestarts()
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	setRestarts(int maximumRestarts)

Methods inherited from class java.lang.Object

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

Constructor Detail

MaximumRestarts

public MaximumRestarts()

Creates a new instance of MaximumRestarts.

MaximumRestarts

public MaximumRestarts(MaximumRestarts copy)

MaximumRestarts

public MaximumRestarts(int maximumRestarts)

Method Detail

getClone

public MaximumRestarts getClone()

Description copied from interface: Cloneable

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()

getRestarts

public int getRestarts()

setRestarts

public void setRestarts(int maximumRestarts)

getPercentageCompleted

public double getPercentageCompleted()

Description copied from interface: StoppingCondition

Determines the percentage complete for the associated algorithm.

Specified by:

getPercentageCompleted in interface StoppingCondition

isCompleted

public boolean isCompleted()

Description copied from interface: StoppingCondition

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)

Description copied from interface: StoppingCondition

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.