MOEA Framework 2.12
API Specification

org.moeaframework.analysis.sensitivity
Class Analysis

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

public class Analysis
extends CommandLineUtility

Command line utility for calculating the best, probability of attainment, efficiency and controllability metrics. These search control metrics are discussed in detail in [1].

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

Arguments:

-p, --parameterFile Location of the parameter configuration file (required)
-i, --parameters Location of the parameter sample file (required)
-m, --metric The metric index (or column) to use for the analysis (required). Indices are 0-based, so 0 indicates the first column in the input.
-v, --hypervolume The target or ideal hypervolume value, used to normalize the hypervolume in the analysis.
-o, --output Location where the output file containing the analysis results is saved. Of not given, the output is printed to the console.
-e, --efficiency Include the efficiency metric in the analysis results.
-b, --band The width of the NFE band. The efficiency metric groups samples with similar NFE together (i.e., those in the same band).
-c, --controllability Include the controllability metric in the analysis results.
-t, --threshold The performance threshold as a percentage when computing the attainment, efficiency, and controllability metrics.
<files> One or more files containing the metric results (i.e., the output from ResultFileEvaluator).

References:

  1. Hadka, D. and Reed, P. "Diagnostic Assessment of Search Controls and Failure Modes in Many-Objective Evolutionary Optimization." Evolutionary Computation.


Constructor Summary
Analysis()
          Constructs the command line utility for calculating the best, probability of attainment, efficiency and controllability metrics.
 
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 calculating the best, probability of attainment, efficiency and controllability metrics.
 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
 

Constructor Detail

Analysis

public Analysis()
Constructs the command line utility for calculating the best, probability of attainment, efficiency and controllability metrics.

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 Exception
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:
Exception

main

public static void main(String[] args)
                 throws Exception
Starts the command line utility for calculating the best, probability of attainment, efficiency and controllability metrics.

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!