com.sas.cas.actions.optimization

Class TunerParams

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.optimization.TunerParams

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class TunerParams
extends CASGeneratedActionOptions

Options for tuner: Tunes a mixed integer linear optimization problem.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TunerParams.GOAL
static class	TunerParams.LOGLEVEL
static class	TunerParams.OPTIONMODE

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_GOAL
static java.lang.String	KEY_LOGFREQ
static java.lang.String	KEY_LOGLEVEL
static java.lang.String	KEY_MAXCONFIGS
static java.lang.String	KEY_MAXTIME
static java.lang.String	KEY_NTHREADS
static java.lang.String	KEY_OPTIONMODE
static java.lang.String	KEY_PRINTLEVEL
static java.lang.String	KEY_TUNEROUT
static java.lang.String	KEY_TUNERSEED

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
TunerParams()
TunerParams(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
TunerParams.GOAL	getGoal()
java.lang.Integer	getLogFreq()
TunerParams.LOGLEVEL	getLogLevel()
java.lang.Integer	getMaxConfigs()
java.lang.Double	getMaxTime()
java.lang.Integer	getNThreads()
java.lang.Integer	getNumThreads()
TunerParams.OPTIONMODE	getOptionMode()
java.lang.Integer	getPrintLevel()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Casouttable	getTOut()
Casouttable	getTunerOut()
java.lang.Integer	getTunerSeed()
TunerParams	setGoal(TunerParams.GOAL value) Sets the value of parameter 'goal'.
TunerParams	setLogFreq(java.lang.Integer value) Sets the value of parameter 'logFreq': specifies how often information is printed in the log.
TunerParams	setLogLevel(TunerParams.LOGLEVEL value) Sets the value of parameter 'logLevel': controls the amount of information displayed in the log.
TunerParams	setMaxConfigs(java.lang.Integer value) Sets the value of parameter 'maxConfigs': specifies limit of number of configurations for tuning.
TunerParams	setMaxTime(java.lang.Double value) Sets the value of parameter 'maxTime': specifies maximum time allowed for the tuner to evaluate parameter configurations in tuning problems.
TunerParams	setNThreads(java.lang.Integer value) Sets the value of parameter 'nThreads': specifies the number of threads to use.
TunerParams	setNumThreads(java.lang.Integer value)
TunerParams	setOptionMode(TunerParams.OPTIONMODE value) Sets the value of parameter 'optionMode': specifies which set of parameters to tune.
TunerParams	setPrintLevel(java.lang.Integer value) Sets the value of parameter 'printLevel': specifies the amount of information that is returned.
TunerParams	setTOut(Casouttable value)
TunerParams	setTunerOut(Casouttable value) Sets the value of parameter 'tunerOut': specifies the output data table for the detailed tuning results.This data table contains solution summary for each problem under different parameter values.
TunerParams	setTunerSeed(java.lang.Integer value) Sets the value of parameter 'tunerSeed': specifies the initial seed of the random number generator for the tuner.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

KEY_GOAL

public static final java.lang.String KEY_GOAL

See Also:

Constant Field Values

KEY_LOGFREQ

public static final java.lang.String KEY_LOGFREQ

See Also:

Constant Field Values

KEY_LOGLEVEL

public static final java.lang.String KEY_LOGLEVEL

See Also:

Constant Field Values

KEY_MAXCONFIGS

public static final java.lang.String KEY_MAXCONFIGS

See Also:

Constant Field Values

KEY_MAXTIME

public static final java.lang.String KEY_MAXTIME

See Also:

Constant Field Values

KEY_NTHREADS

public static final java.lang.String KEY_NTHREADS

See Also:

Constant Field Values

KEY_OPTIONMODE

public static final java.lang.String KEY_OPTIONMODE

See Also:

Constant Field Values

KEY_PRINTLEVEL

public static final java.lang.String KEY_PRINTLEVEL

See Also:

Constant Field Values

KEY_TUNERSEED

public static final java.lang.String KEY_TUNERSEED

See Also:

Constant Field Values

KEY_TUNEROUT

public static final java.lang.String KEY_TUNEROUT

See Also:

Constant Field Values

Constructor Detail

TunerParams

public TunerParams()

TunerParams

public TunerParams(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getGoal

public TunerParams.GOAL getGoal()

setGoal

public TunerParams setGoal(TunerParams.GOAL value)

Sets the value of parameter 'goal'. The server default is GOAL.GEOMEAN.

Parameters:

value - The value

Returns:

The options object

getLogFreq

public java.lang.Integer getLogFreq()

setLogFreq

public TunerParams setLogFreq(java.lang.Integer value)

Sets the value of parameter 'logFreq': specifies how often information is printed in the log. The default is automatically determined and depends on the algorithms used. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getLogLevel

public TunerParams.LOGLEVEL getLogLevel()

setLogLevel

public TunerParams setLogLevel(TunerParams.LOGLEVEL value)

Sets the value of parameter 'logLevel': controls the amount of information displayed in the log. The server default is LOGLEVEL.MODERATE.

Parameters:

value - The value

Returns:

The options object

getMaxConfigs

public java.lang.Integer getMaxConfigs()

setMaxConfigs

public TunerParams setMaxConfigs(java.lang.Integer value)

Sets the value of parameter 'maxConfigs': specifies limit of number of configurations for tuning. The server default is 1000.

Parameters:

value - The value

Returns:

The options object

getMaxTime

public java.lang.Double getMaxTime()

setMaxTime

public TunerParams setMaxTime(java.lang.Double value)

Sets the value of parameter 'maxTime': specifies maximum time allowed for the tuner to evaluate parameter configurations in tuning problems. The server default is 3600.

Parameters:

value - The value

Returns:

The options object

getNThreads

public java.lang.Integer getNThreads()

getNumThreads

public java.lang.Integer getNumThreads()

setNThreads

public TunerParams setNThreads(java.lang.Integer value)

Sets the value of parameter 'nThreads': specifies the number of threads to use. Setting the nthreads parameter to a number greater than the actual number of available cores might result in reduced performance. Specifying a high nThreads value does not guarantee shorter solution time; the actual change in solution time depends on the computing hardware and the scalability of the underlying algorithms in the specified procedure. In some circumstances, a procedure might use fewer threads than the specified value of the nThreads parameter because the procedure's internal algorithms have determined that a smaller number is preferable. The default is the number of cores on the machine that executes the process, or the number of cores permissible based on your installation (whichever is less). The number of simultaneously active CPUs is limited by your installation and license configuration.

Parameters:

value - The value

Returns:

The options object

setNumThreads

public TunerParams setNumThreads(java.lang.Integer value)

getOptionMode

public TunerParams.OPTIONMODE getOptionMode()

setOptionMode

public TunerParams setOptionMode(TunerParams.OPTIONMODE value)

Sets the value of parameter 'optionMode': specifies which set of parameters to tune. The server default is OPTIONMODE.AUTOMATIC.

Parameters:

value - The value

Returns:

The options object

getPrintLevel

public java.lang.Integer getPrintLevel()

setPrintLevel

public TunerParams setPrintLevel(java.lang.Integer value)

Sets the value of parameter 'printLevel': specifies the amount of information that is returned. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getTunerSeed

public java.lang.Integer getTunerSeed()

setTunerSeed

public TunerParams setTunerSeed(java.lang.Integer value)

Sets the value of parameter 'tunerSeed': specifies the initial seed of the random number generator for the tuner. The server default is 100.

Parameters:

value - The value

Returns:

The options object

getTunerOut

public Casouttable getTunerOut()

getTOut

public Casouttable getTOut()

setTunerOut

public TunerParams setTunerOut(Casouttable value)

Sets the value of parameter 'tunerOut': specifies the output data table for the detailed tuning results.This data table contains solution summary for each problem under different parameter values.

Parameters:

value - The value

Returns:

The options object

setTOut

public TunerParams setTOut(Casouttable value)