jenes.stage

Class ExclusiveDispenser<T extends Chromosome>

java.lang.Object

jenes.stage.Dispenser<T>

jenes.stage.ExclusiveDispenser<T>

Type Parameters:

T - The class chromosomes flowing across the stage.

Direct Known Subclasses:

SimpleDispenser, SimpleDispenser

public abstract class ExclusiveDispenser<T extends Chromosome>
extends Dispenser<T>

An abstract dispencer useful when each individual can be in only one parallel branch, so the distribute method is exclusive.
The only method to implement is distribute(Individual) to specify the branch number in which store the specified Individual.

Note: the predistribute method of this class has empty implementation. Override it if you need to evaluate preDistrubute statistics.

Since:

1.0

Version:

1.2

See Also:

Parallel

Field Summary

Fields inherited from class jenes.stage.Dispenser

span

Constructor Summary

Constructors

Constructor and Description
ExclusiveDispenser(int span) Constructs a new exclusive dispencer with the specified amplitude

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	distribute(Individual<T> ind) Returns the branch number where to add the specified individual.
void	distribute(Population<T> in, Population<T>[] branches) Distributes the specified population between those ones in the specified array.
void	mergePopulation(Population<T>[] branches, Population<T> out) Merges the populations within the specified array in the specified one.
void	postDistribute(Population<T>[] branches) Callback method invoked just after distribution of individuals is done.
void	postMerge(Population<T> population) Callback method invoked just after merge of individuals is done.
void	preDistribute(Population<T> population) Callback method invoked just before distribution of individuals begins.
void	preMerge(Population<T>[] branches) Callback method invoked just before merge of branches begins.

Methods inherited from class jenes.stage.Dispenser

span

Methods inherited from class java.lang.Object

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

Constructor Detail

ExclusiveDispenser

public ExclusiveDispenser(int span)

Constructs a new exclusive dispencer with the specified amplitude

Parameters:

span - the dispencer amplitude

Method Detail

distribute

public final void distribute(Population<T> in,
              Population<T>[] branches)

Distributes the specified population between those ones in the specified array. If some populations within inStagePop are not empty they will contain the initial individuals too at the end of distribute operation. The branch in which each individual is dispatched is given by the distribute(Individual) method

Specified by:

distribute in class Dispenser<T extends Chromosome>

Parameters:

in - the population to be distributed

branches - the array of sub populations of the initial one

distribute

public abstract int distribute(Individual<T> ind)

Returns the branch number where to add the specified individual. Branches are numbered from 0 to span-1

Parameters:

ind - the individual to distribute

Returns:

the branch number where to add the individual

mergePopulation

public final void mergePopulation(Population<T>[] branches,
                   Population<T> out)

Merges the populations within the specified array in the specified one. If population is not empty it will contain the initial individuals too at the end of merge operation. Note: if out have a different size than the input population used in the distribute(Population, Population[]) method out will be resized to fit the input population size.

Specified by:

mergePopulation in class Dispenser<T extends Chromosome>

Parameters:

out - the final population

branches - the populations to be merged

preDistribute

public void preDistribute(Population<T> population)

Callback method invoked just before distribution of individuals begins. By default this method does nothing. It an be overriden in order to perform custom operations.

Parameters:

population - the population to distribute

postDistribute

public void postDistribute(Population<T>[] branches)

Callback method invoked just after distribution of individuals is done. By default this method does nothing. It an be overriden in order to perform custom operations.

Parameters:

branches - populations as distributed

preMerge

public void preMerge(Population<T>[] branches)

Callback method invoked just before merge of branches begins. By default this method does nothing. It an be overriden in order to perform custom operations.

Parameters:

branches - populations as resulting from the different branches

postMerge

public void postMerge(Population<T> population)

Callback method invoked just after merge of individuals is done. By default this method does nothing. It an be overriden in order to perform custom operations.

Parameters:

population - the merged population