MOEA Framework 2.12
API Specification

org.moeaframework.analysis.sensitivity
Class Evaluator

java.lang.Object
  extended by org.moeaframework.util.CommandLineUtility
      extended by org.moeaframework.analysis.sensitivity.Evaluator

public class Evaluator
extends CommandLineUtility

Command line utility for evaluating an algorithm using many parameterizations.

Usage: java -cp "..." org.moeaframework.analysis.sensitivity.Evaluator <options>

Arguments:

-p, --parameterFile Location of the parameter configuration file (required)
-i, --input Location of the parameter sample file (required)
-o, --output The location of the output file. Each record in the output file will correspond to the end-of-run approximation set from each parameterization read from the parameter sample file.
-b, --problem The name of the problem. This name should reference one of the problems recognized by the MOEA Framework.
-a, --algorithm The name of the algorithm. This name should reference one of the algorithms recognized by the MOEA Framework.
-x, --properties Semicolon-separated list of additional parameters for the algorithm (e.g., -x maxEvaluations=10000;populationSize=100.
-s, --seed The random number seed used for each run.
-e, --epsilon The epsilon values for limiting the size of the results. This epsilon value is also used for any algorithms that include an epsilon parameter.
-m, --metrics Compute the performance metrics and output a metric file. This is equivalent to running ResultFileEvaluator on the result file produced by this command.
-r, --reference Location of the reference file used when computing the performance metrics (required if -m is set).
-n, --novariables To save on space, do not save decision variables in the results.


Field Summary
protected  SampleReader input
          The sample reader from which input parameters are read.
protected  OutputWriter output
          The output writer where end-of-run results are stored.
protected  Problem problem
          The problem being evaluated.
 
Constructor Summary
Evaluator()
          Constructs the command line utility for evaluating an algorithm using many parameterizations.
 
Method Summary
 org.apache.commons.cli.Options getOptions()
          Returns the options made available by this command line utility.
static void main(String[] args)
          Starts the command line utility for evaluating an algorithm using many parameterizations.
protected  void process(String algorithmName, Properties properties)
          Performs a single run of the specified algorithm using the parameters.
 void run(org.apache.commons.cli.CommandLine commandLine)
          Runs this command line utility with the specified command line arguments.
 
Methods inherited from class org.moeaframework.util.CommandLineUtility
getCommandString, setCommandString, start
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

problem

protected Problem problem
The problem being evaluated.


output

protected OutputWriter output
The output writer where end-of-run results are stored.


input

protected SampleReader input
The sample reader from which input parameters are read.

Constructor Detail

Evaluator

public Evaluator()
Constructs the command line utility for evaluating an algorithm using many parameterizations.

Method Detail

getOptions

public org.apache.commons.cli.Options getOptions()
Description copied from class: CommandLineUtility
Returns the options made available by this command line utility. The base implementation automatically provides the -h,--help option. Implementations overriding this method and begin with a call to super.getOptions().

Overrides:
getOptions in class CommandLineUtility
Returns:
the options made available by this command line utility

run

public void run(org.apache.commons.cli.CommandLine commandLine)
         throws IOException
Description copied from class: CommandLineUtility
Runs this command line utility with the specified command line arguments.

Specified by:
run in class CommandLineUtility
Parameters:
commandLine - the command line arguments
Throws:
IOException

process

protected void process(String algorithmName,
                       Properties properties)
                throws IOException
Performs a single run of the specified algorithm using the parameters.

Parameters:
algorithmName - the algorithm name
properties - the parameters stored in a properties object
Throws:
IOException - if an I/O error occurred

main

public static void main(String[] args)
                 throws Exception
Starts the command line utility for evaluating an algorithm using many parameterizations.

Parameters:
args - the command line arguments
Throws:
Exception - if an error occurred

MOEA Framework 2.12
API Specification

Copyright 2009-2016 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Visit us on Github!