MOEA Framework 2.3
API Specification

org.moeaframework.analysis.collector
Class IndicatorCollector

java.lang.Object
  extended by org.moeaframework.analysis.collector.IndicatorCollector
All Implemented Interfaces:
Collector

public class IndicatorCollector
extends Object
implements Collector

Collects performance indicator values from an Algorithm.


Constructor Summary
IndicatorCollector(Indicator indicator)
          Constructs an unattached collector for recording performance indicator values from an algorithm.
IndicatorCollector(Indicator indicator, EpsilonBoxDominanceArchive archive)
          Constructs an unattached collector for recording performance indicator values from an algorithm, with an ε-box dominance archive to prune the approximation set to a desired resolution.
IndicatorCollector(Indicator indicator, EpsilonBoxDominanceArchive archive, Algorithm algorithm)
          Constructs a collector for recording performance indicator values from the specified algorithm.
 
Method Summary
 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(Accumulator accumulator)
          Collects the necessary information from the object, storing the data to the specified accumulator.
 AttachPoint getAttachPoint()
          Returns the attach point describing where this collector is attached.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndicatorCollector

public IndicatorCollector(Indicator indicator)
Constructs an unattached collector for recording performance indicator values from an algorithm.

Parameters:
indicator - the performance indicator used by this collector

IndicatorCollector

public IndicatorCollector(Indicator indicator,
                          EpsilonBoxDominanceArchive archive)
Constructs an unattached collector for recording performance indicator values from an algorithm, with an ε-box dominance archive to prune the approximation set to a desired resolution.

Parameters:
indicator - the performance indicator used by this collector
archive - the ε-box dominance archive used to prune the approximation set to a desired resolution; or null if no such pruning is used

IndicatorCollector

public IndicatorCollector(Indicator indicator,
                          EpsilonBoxDominanceArchive archive,
                          Algorithm algorithm)
Constructs a collector for recording performance indicator values from the specified algorithm.

Parameters:
indicator - the performance indicator used by this collector
archive - the ε-box dominance archive used to prune the approximation set to a desired resolution; or null if no such pruning is used
algorithm - the algorithm this collector records data from
Method Detail

collect

public void collect(Accumulator accumulator)
Description copied from interface: Collector
Collects the necessary information from the object, storing the data to the specified accumulator. This method must only be invoked after this collector has been attached to an appropriate object.

Specified by:
collect in interface Collector
Parameters:
accumulator - the accumulator to which the collected data is stored

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

MOEA Framework 2.3
API Specification

Copyright 2009-2014 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Hosted by Get MOEA Framework at SourceForge.net. Fast, secure and Free Open Source software downloads