MOEA Framework 2.12
API Specification

org.moeaframework.core
Class Settings

java.lang.Object
  extended by org.moeaframework.core.Settings

public class Settings
extends Object

Global settings used by this framework. The PROPERTIES object contains the system properties and optionally the contents of a configuration file (properties in the configuration file take precedence). By default, the global.properties file is loaded, but can be specified using the org.moeaframework.configuration system property.


Field Summary
static int BUFFER_SIZE
          The default buffer size.
static double EPS
          Level of significance or machine precision.
static String KEY_ALLOWED_PACKAGES
          Deprecated. no longer used
static String KEY_CLEANUP_STRATEGY
          The property key for the cleanup strategy when restarting from previous runs.
static String KEY_CONTINUITY_CORRECTION
          The property key for the continuity correction flag.
static String KEY_DIAGNOSTIC_TOOL_ALGORITHMS
          The property key for the algorithms available in the diagnostic tool.
static String KEY_DIAGNOSTIC_TOOL_PROBLEMS
          The property key for the problems available in the diagnostic tool.
static String KEY_DUPLICATE_MODE
          The property key for how to handle duplicate solutions in a nondominated population.
static String KEY_FAST_NONDOMINATED_SORTING
          The property key to indicate that fast non-dominated sorting should be used.
static String KEY_FILE_PROTECTION_FORMAT
          The property key for the file protection file name format.
static String KEY_FILE_PROTECTION_MODE
          The property key for the file protection mode.
static String KEY_GD_POWER
          The property key for the power used in the generational distance calculation.
static String KEY_GP_PROTECTED_FUNCTIONS
          The property key for the genetic programming protected functions flag.
static String KEY_HYPERVOLUME
          The property key for the hypervolume command.
static String KEY_HYPERVOLUME_DELTA
          The property key for the hypervolume delta when determining the reference point.
static String KEY_HYPERVOLUME_ENABLED
          The property key for the hypervolume flag.
static String KEY_HYPERVOLUME_INVERTED
          The property key for the hypervolume inversion flag.
static String KEY_IDEALPT_PREFIX
          The prefix for specifying custom ideal points for different problems.
static String KEY_IGD_POWER
          The property key for the power used in the inverted generational distance calculation.
static String KEY_PISA_ALGORITHMS
          The property key for the list of available PISA algorithms.
static String KEY_PISA_POLL
          The property key for the poll rate.
static String KEY_PISA_PREFIX
          The prefix for all PISA property keys.
static String KEY_PREFIX
          The prefix for all property keys.
static String KEY_PROBLEM_LIST
          The property key for the list of available problems.
static String KEY_PROBLEM_PREFIX
          The prefix for all problem property keys.
static String KEY_REFPT_PREFIX
          The prefix for specifying custom reference points for different problems.
static String NEW_LINE
          Store the new line character to prevent repetitive calls to System.getProperty("line.separator").
static TypedProperties PROPERTIES
          The global properties object.
 
Method Summary
static String[] getAllowedPackages()
          Deprecated. no longer used
static String getCleanupStrategy()
          Returns the cleanup strategy when restarting from a previous run.
static String[] getDiagnosticToolAlgorithms()
          Returns the list of algorithms displayed in the diagnostic tool GUI.
static String[] getDiagnosticToolProblems()
          Returns the list of problems displayed in the diagnostic tool GUI.
static NondominatedPopulation.DuplicateMode getDuplicateMode()
          Returns the strategy used for handling duplicate solutions in a nondominated population.
static String getFileProtectionFormat()
          Returns the file protection file name format.
static String getFileProtectionMode()
          Returns the file protection mode.
static double getGDPower()
          Returns the power used in the generational distance calculation.
static String getHypervolume()
          Returns the native hypervolume command; or null if the default hypervolume implementation is used.
static double getHypervolumeDelta()
          Returns the delta applied to the nadir point of the reference set when calculating the hypervolume.
static List<Image> getIconImages()
          Returns the MOEA Framework icons of various sizes.
static double[] getIdealPoint(String problem)
          Returns the ideal point for the given problem, or null if one is not specified.
static double getIGDPower()
          Returns the power used in the inverted generational distance calculation.
static String[] getPISAAlgorithms()
          Returns the list of available PISA selectors.
static String getPISACommand(String algorithmName)
          Returns the command, invokable through Runtime.exec(String), for starting the PISA selector.
static String getPISAConfiguration(String algorithmName)
          Returns the configuration file for the PISA selector.
static String getPISAParameterDefaultValue(String algorithmName, String parameterName)
          Returns the default value of the specified parameter for the PISA selector.
static String[] getPISAParameters(String algorithmName)
          Returns the list of parameter names for the PISA selector.
static int getPISAPollRate()
          Returns the poll rate, in milliseconds, for how often PISA checks the state file.
static String getProblemClass(String name)
          Returns the class for the specified problem.
static String getProblemReferenceSet(String name)
          Returns the reference set filename for the specified problem.
static String[] getProblems()
          Returns the list of available problems.
static double[] getReferencePoint(String problem)
          Returns the reference point for the given problem, or null if one is not specified.
static boolean isContinuityCorrection()
          Returns true if continuity correction is enabled; false otherwise.
static boolean isHypervolumeEnabled()
          Returns true if hypervolume calculation is enabled; false otherwise.
static boolean isHypervolumeInverted()
          Returns true if the approximation set is inverted prior to being passed to the custom hypervolume implementation; otherwise false.
static boolean isProtectedFunctions()
          Returns true if genetic programming functions should use protection against invalid arguments that would otherwise result in NaN or other invalid values; false otherwise.
static String[] parseCommand(String command)
          Splits an executable command into its individual arguments.
static boolean useFastNondominatedSorting()
          Returns true if fast non-dominated sorting should be used; or false if the naive non-dominated sorting implementation is preferred.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EPS

public static final double EPS
Level of significance or machine precision.

See Also:
Constant Field Values

BUFFER_SIZE

public static final int BUFFER_SIZE
The default buffer size. Currently set to 4096 bytes.

See Also:
Constant Field Values

NEW_LINE

public static final String NEW_LINE
Store the new line character to prevent repetitive calls to System.getProperty("line.separator").


PROPERTIES

public static final TypedProperties PROPERTIES
The global properties object.


KEY_PREFIX

public static final String KEY_PREFIX
The prefix for all property keys.

See Also:
Constant Field Values

KEY_DUPLICATE_MODE

public static final String KEY_DUPLICATE_MODE
The property key for how to handle duplicate solutions in a nondominated population.

See Also:
Constant Field Values

KEY_GD_POWER

public static final String KEY_GD_POWER
The property key for the power used in the generational distance calculation.

See Also:
Constant Field Values

KEY_IGD_POWER

public static final String KEY_IGD_POWER
The property key for the power used in the inverted generational distance calculation.

See Also:
Constant Field Values

KEY_FAST_NONDOMINATED_SORTING

public static final String KEY_FAST_NONDOMINATED_SORTING
The property key to indicate that fast non-dominated sorting should be used.

See Also:
Constant Field Values

KEY_CONTINUITY_CORRECTION

public static final String KEY_CONTINUITY_CORRECTION
The property key for the continuity correction flag.

See Also:
Constant Field Values

KEY_HYPERVOLUME_DELTA

public static final String KEY_HYPERVOLUME_DELTA
The property key for the hypervolume delta when determining the reference point.

See Also:
Constant Field Values

KEY_IDEALPT_PREFIX

public static final String KEY_IDEALPT_PREFIX
The prefix for specifying custom ideal points for different problems.

See Also:
Constant Field Values

KEY_REFPT_PREFIX

public static final String KEY_REFPT_PREFIX
The prefix for specifying custom reference points for different problems.

See Also:
Constant Field Values

KEY_HYPERVOLUME

public static final String KEY_HYPERVOLUME
The property key for the hypervolume command.

See Also:
Constant Field Values

KEY_HYPERVOLUME_INVERTED

public static final String KEY_HYPERVOLUME_INVERTED
The property key for the hypervolume inversion flag.

See Also:
Constant Field Values

KEY_HYPERVOLUME_ENABLED

public static final String KEY_HYPERVOLUME_ENABLED
The property key for the hypervolume flag.

See Also:
Constant Field Values

KEY_PROBLEM_PREFIX

public static final String KEY_PROBLEM_PREFIX
The prefix for all problem property keys.

See Also:
Constant Field Values

KEY_PROBLEM_LIST

public static final String KEY_PROBLEM_LIST
The property key for the list of available problems.

See Also:
Constant Field Values

KEY_PISA_PREFIX

public static final String KEY_PISA_PREFIX
The prefix for all PISA property keys.

See Also:
Constant Field Values

KEY_PISA_ALGORITHMS

public static final String KEY_PISA_ALGORITHMS
The property key for the list of available PISA algorithms.

See Also:
Constant Field Values

KEY_PISA_POLL

public static final String KEY_PISA_POLL
The property key for the poll rate.

See Also:
Constant Field Values

KEY_FILE_PROTECTION_MODE

public static final String KEY_FILE_PROTECTION_MODE
The property key for the file protection mode.

See Also:
Constant Field Values

KEY_FILE_PROTECTION_FORMAT

public static final String KEY_FILE_PROTECTION_FORMAT
The property key for the file protection file name format.

See Also:
Constant Field Values

KEY_DIAGNOSTIC_TOOL_ALGORITHMS

public static final String KEY_DIAGNOSTIC_TOOL_ALGORITHMS
The property key for the algorithms available in the diagnostic tool.

See Also:
Constant Field Values

KEY_DIAGNOSTIC_TOOL_PROBLEMS

public static final String KEY_DIAGNOSTIC_TOOL_PROBLEMS
The property key for the problems available in the diagnostic tool.

See Also:
Constant Field Values

KEY_GP_PROTECTED_FUNCTIONS

public static final String KEY_GP_PROTECTED_FUNCTIONS
The property key for the genetic programming protected functions flag.

See Also:
Constant Field Values

KEY_CLEANUP_STRATEGY

public static final String KEY_CLEANUP_STRATEGY
The property key for the cleanup strategy when restarting from previous runs.

See Also:
Constant Field Values

KEY_ALLOWED_PACKAGES

@Deprecated
public static final String KEY_ALLOWED_PACKAGES
Deprecated. no longer used
The property key for listing the allowed packages that can be instrumented.

See Also:
Constant Field Values
Method Detail

isContinuityCorrection

public static boolean isContinuityCorrection()
Returns true if continuity correction is enabled; false otherwise. Rank-based statistical inference methods, such as the Mann-Whitney U test and the Wilcoxon Signed-Ranks test, approximate the test's discrete distribution with a continuous distribution for computing the p-value. It has been recommended but not often employed in practice to apply a continuity correction.

Returns:
true if continuity correction is enabled; false otherwise

getDuplicateMode

public static NondominatedPopulation.DuplicateMode getDuplicateMode()
Returns the strategy used for handling duplicate solutions in a nondominated population.

Returns:
the strategy for handling duplicate solutions

getGDPower

public static double getGDPower()
Returns the power used in the generational distance calculation. The default value is 2.0.

Returns:
the power used in the generational distance calculation

getIGDPower

public static double getIGDPower()
Returns the power used in the inverted generational distance calculation. The default value is 1.0.

Returns:
the power used in the inverted generational distance calculation

getIdealPoint

public static double[] getIdealPoint(String problem)
Returns the ideal point for the given problem, or null if one is not specified.

Parameters:
problem - the problem name
Returns:
the ideal point

getReferencePoint

public static double[] getReferencePoint(String problem)
Returns the reference point for the given problem, or null if one is not specified.

Parameters:
problem - the problem name
Returns:
the reference point

useFastNondominatedSorting

public static boolean useFastNondominatedSorting()
Returns true if fast non-dominated sorting should be used; or false if the naive non-dominated sorting implementation is preferred. The default is false since while the fast version has better worst-case time complexity, the naive version tends to run faster except for a small number of edge cases.

Returns:
true if fast non-dominated sorting should be used; or false if the naive non-dominated sorting implementation is preferred

getHypervolumeDelta

public static double getHypervolumeDelta()
Returns the delta applied to the nadir point of the reference set when calculating the hypervolume. Having a non-zero delta is necessary to ensure extremal solutions contribute to the hypervolume.

Returns:
the delta applied to the nadir point of the reference set when calculating the hypervolume

getHypervolume

public static String getHypervolume()
Returns the native hypervolume command; or null if the default hypervolume implementation is used. The default hypervolume implementation may become computationally prohibitive on large approximation sets or at high dimensions. The following variable substitutions are provided:

Returns:
the native hypervolume command; or null if the default hypervolume implementation is used

isHypervolumeInverted

public static boolean isHypervolumeInverted()
Returns true if the approximation set is inverted prior to being passed to the custom hypervolume implementation; otherwise false.

Returns:
true if the approximation set is inverted prior to being passed to the custom hypervolume implementation; otherwise false

isHypervolumeEnabled

public static boolean isHypervolumeEnabled()
Returns true if hypervolume calculation is enabled; false otherwise. When disabled, the hypervolume should be reported as Double.NaN. Direct use of the Hypervolume class remains unaffected by this option.

Returns:
true if hypervolume calculation is enabled; false otherwise

getProblems

public static String[] getProblems()
Returns the list of available problems. This allows enumerating additional problems without the need for defining and registering a service provider on the classpath.

Returns:
the list of available problems

getProblemClass

public static String getProblemClass(String name)
Returns the class for the specified problem.

Parameters:
name - the problem name
Returns:
the class for the specified problem

getProblemReferenceSet

public static String getProblemReferenceSet(String name)
Returns the reference set filename for the specified problem.

Parameters:
name - the problem name
Returns:
the reference set filename for the specified problem

getPISAAlgorithms

public static String[] getPISAAlgorithms()
Returns the list of available PISA selectors.

Returns:
the list of available PISA selectors

getPISAPollRate

public static int getPISAPollRate()
Returns the poll rate, in milliseconds, for how often PISA checks the state file.

Returns:
the poll rate, in milliseconds, for how often PISA checks the state file

getPISACommand

public static String getPISACommand(String algorithmName)
Returns the command, invokable through Runtime.exec(String), for starting the PISA selector.

Parameters:
algorithmName - the name of the PISA selector
Returns:
the command, invokable through Runtime.exec(String), for starting the PISA selector

getPISAConfiguration

public static String getPISAConfiguration(String algorithmName)
Returns the configuration file for the PISA selector.

Parameters:
algorithmName - the name of the PISA selector
Returns:
the configuration file for the PISA selector

getPISAParameters

public static String[] getPISAParameters(String algorithmName)
Returns the list of parameter names for the PISA selector.

Parameters:
algorithmName - the name of the PISA selector
Returns:
the list of parameter names for the PISA selector

getPISAParameterDefaultValue

public static String getPISAParameterDefaultValue(String algorithmName,
                                                  String parameterName)
Returns the default value of the specified parameter for the PISA selector.

Parameters:
algorithmName - the name of the PISA selector
parameterName - the name of the parameter
Returns:
the default value of the specified parameter for the PISA selector

getFileProtectionMode

public static String getFileProtectionMode()
Returns the file protection mode. Valid modes include

Returns:
the file protection mode

getFileProtectionFormat

public static String getFileProtectionFormat()
Returns the file protection file name format. The following variable substitutions are provided:

Returns:
the file protection file name format

getDiagnosticToolAlgorithms

public static String[] getDiagnosticToolAlgorithms()
Returns the list of algorithms displayed in the diagnostic tool GUI.

Returns:
the list of algorithms displayed in the diagnostic tool GUI

getDiagnosticToolProblems

public static String[] getDiagnosticToolProblems()
Returns the list of problems displayed in the diagnostic tool GUI.

Returns:
the list of problems displayed in the diagnostic tool GUI

parseCommand

public static String[] parseCommand(String command)
Splits an executable command into its individual arguments. This method allows quoted text ("...") in properties to be treated as an individual argument as required by ProcessBuilder.

Parameters:
command - the command represented in a single string
Returns:
the individual arguments comprising the command

isProtectedFunctions

public static boolean isProtectedFunctions()
Returns true if genetic programming functions should use protection against invalid arguments that would otherwise result in NaN or other invalid values; false otherwise.

Returns:
true if genetic programming functions should use protection against invalid arguments that would otherwise result in NaN or other invalid values; false otherwise

getCleanupStrategy

public static String getCleanupStrategy()
Returns the cleanup strategy when restarting from a previous run. Possible values are error, overwrite, and restore. The default is error. Any other values should default to error.

Returns:
the cleanup strategy when restarting from a previous run

getAllowedPackages

@Deprecated
public static String[] getAllowedPackages()
Deprecated. no longer used

Returns the allowed packages that can be instrumented. By default, only packages in "org.moeaframework" can be instrumented.

Returns:
the allowed packages that can be instrumented

getIconImages

public static List<Image> getIconImages()
Returns the MOEA Framework icons of various sizes.

Returns:
the MOEA Framework icons

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!