Apache Commons Math 3.6.1 · org.apache.commons.math3.genetics.FixedGenerationCount

Stops after a fixed number of generations. Each time isSatisfied(Population) is invoked, a generation counter is incremented. Once the counter reaches the configured maxGenerations value, isSatisfied(Population) returns true.

Field Summary

Modifier and Type	Field and Description
private final int	maxGenerations Maximum number of generations (stopping criteria)
private int	numGenerations Number of generations that have passed

Constructor Summary

Access	Constructor and Description
public	FixedGenerationCount(final int number of generations to evolve maxGenerations) Create a new FixedGenerationCount instance.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the number of generations that have passed getNumGenerations() Returns the number of generations that have already passed.
public boolean	Returns: `true` IFF the maximum number of generations has been exceeded isSatisfied(final Population ignored (no impact on result) population) Implements org.apache.commons.math3.genetics.StoppingCondition.isSatisfied. Determine whether or not the given number of generations have passed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

maxGenerations	back to summary
private final int maxGenerations Maximum number of generations (stopping criteria)

numGenerations	back to summary
private int numGenerations Number of generations that have passed

Constructor Detail

FixedGenerationCount	back to summary
public FixedGenerationCount(final int maxGenerations) throws NumberIsTooSmallException Create a new FixedGenerationCount instance. Parameters maxGenerations:int number of generations to evolve Exceptions NumberIsTooSmallException: if the number of generations is < 1

FixedGenerationCount

back to summary

public FixedGenerationCount(final int maxGenerations) throws NumberIsTooSmallException

Create a new FixedGenerationCount instance.

Parameters

maxGenerations:int: number of generations to evolve

Exceptions

NumberIsTooSmallException:: if the number of generations is < 1

Method Detail

getNumGenerations	back to summary
public int getNumGenerations() Returns the number of generations that have already passed. Returns:int the number of generations that have passed

getNumGenerations

back to summary

public int getNumGenerations()

Returns the number of generations that have already passed.

Returns:int: the number of generations that have passed

isSatisfied back to summary

isSatisfied	back to summary
public boolean isSatisfied(final Population population) Implements org.apache.commons.math3.genetics.StoppingCondition.isSatisfied. Determine whether or not the given number of generations have passed. Increments the number of generations counter if the maximum has not been reached. Parameters population:Population ignored (no impact on result) Returns:boolean `true` IFF the maximum number of generations has been exceeded

public boolean isSatisfied(final Population population)

Implements org.apache.commons.math3.genetics.StoppingCondition.isSatisfied.

Determine whether or not the given number of generations have passed. Increments the number of generations counter if the maximum has not been reached.