Package org.moeaframework.analysis.collector

Class PopulationCollector

java.lang.Object

org.moeaframework.analysis.collector.PopulationCollector

All Implemented Interfaces:

Collector

public class PopulationCollector
extends Object
implements Collector

Collects the population from an EvolutionaryAlgorithm.

Constructor Summary

Constructors

Constructor	Description
PopulationCollector()	Constructs an unattached collector for recording the population from an EvolutionaryAlgorithm.
PopulationCollector(EvolutionaryAlgorithm algorithm)	Constructs a collector for recording the population from the specified EvolutionaryAlgorithm.

Method Summary

Modifier and Type	Method	Description
Collector	attach(Object object)	Returns a new instance of this collector which has been attached to the specified object as identified by the attach point returned through Collector.getAttachPoint().
void	collect(Observation observation)	Collects the requested information from the object, storing the data to the specified observation.
AttachPoint	getAttachPoint()	Returns the attach point describing where this collector is attached.
static Population	getPopulation(Observation observation)	Reads the population from the observation.

Methods inherited from class java.lang.Object

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

Constructor Details

PopulationCollector

public PopulationCollector()

Constructs an unattached collector for recording the population from an EvolutionaryAlgorithm.

PopulationCollector

public PopulationCollector(EvolutionaryAlgorithm algorithm)

Constructs a collector for recording the population from the specified EvolutionaryAlgorithm.

Parameters:

algorithm - the algorithm this collector records data from

Method Details

getAttachPoint

public AttachPoint getAttachPoint()

Description copied from interface: Collector

Returns the attach point describing where this collector is attached. The matched object should be unique.

Specified by:

getAttachPoint in interface Collector

Returns:

the attach point describing where this collector is attached

attach

public Collector attach(Object object)

Description copied from interface: Collector

Returns a new instance of this collector which has been attached to the specified object as identified by the attach point returned through Collector.getAttachPoint().

Specified by:

attach in interface Collector

Parameters:

object - the matching object

Returns:

a new instance of this collector which has been attached to the specified object

collect

public void collect(Observation observation)

Description copied from interface: Collector

Collects the requested information from the object, storing the data to the specified observation. This method must only be invoked after this collector has been attached to an appropriate object.

Specified by:

collect in interface Collector

Parameters:

observation - the observation to which the collected data is stored

getPopulation

public static Population getPopulation(Observation observation)

Reads the population from the observation.

Parameters:

observation - the observation

Returns:

the population