MOEA Framework 2.12
API Specification

org.moeaframework.analysis.sensitivity
Class SampleGenerator

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

public class SampleGenerator
extends CommandLineUtility

Command line utility for producing randomly-generated parameters for use by the Evaluator or DetailedEvaluator. The output is called a parameter sample file.

Usage: java -cp "..." org.moeaframework.analysis.sensitivity.SampleGenerator

Arguments:

-n, --numberOfSamples The number of samples to generate. Depending on the selected method, more samples may be generated then given by this option (required).
-p, --parameterFile Location of the parameter configuration file (required)
-m, --method The sampling method, such as latin, sobol, or saltelli (required). If you eventually want to use the results with SobolAnalysis, then use the saltelli method.
-s, --seed The seed used to generate the parameter samples.
-o, --output The output file where the parameter samples are saved.


Constructor Summary
SampleGenerator()
          Constructs the command line utility for producing randomly-generated parameters for use by the Evaluator.
 
Method Summary
 org.apache.commons.cli.Options getOptions()
          Returns the options made available by this command line utility.
static void main(String[] args)
          Command line utility for producing randomly-generated parameters for use by the Evaluator.
 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

SampleGenerator

public SampleGenerator()
Constructs the command line utility for producing randomly-generated parameters for use by the Evaluator.

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

main

public static void main(String[] args)
                 throws Exception
Command line utility for producing randomly-generated parameters for use by the Evaluator.

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!