com.sas.cas.actions.pls

Class MethodOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.pls.MethodOptions

All Implemented Interfaces:

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

public class MethodOptions
extends CASGeneratedActionOptions

Options for pls: Fits models by using any one of a number of linear predictive methods, including partial least squares.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MethodOptions.ALGORITHM
static class	MethodOptions.NAME

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_ALGORITHM
static java.lang.String	KEY_EPSILON
static java.lang.String	KEY_MAXITER
static java.lang.String	KEY_NAME

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
MethodOptions()
MethodOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
MethodOptions.ALGORITHM	getAlg()
MethodOptions.ALGORITHM	getAlgorithm()
java.lang.Double	getEps()
java.lang.Double	getEpsilon()
java.lang.Integer	getMaxIter()
MethodOptions.NAME	getName()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
MethodOptions	setAlg(MethodOptions.ALGORITHM value)
MethodOptions	setAlgorithm(MethodOptions.ALGORITHM value) Sets the value of parameter 'algorithm': specifies the algorithm used to compute extracted PLS factors.
MethodOptions	setEps(java.lang.Double value)
MethodOptions	setEpsilon(java.lang.Double value) Sets the value of parameter 'epsilon': specifies the convergence criterion for the NIPALS algorithm.
MethodOptions	setMaxIter(java.lang.Integer value) Sets the value of parameter 'maxIter': specifies the maximum number of iterations for the NIPALS algorithm.
MethodOptions	setName(MethodOptions.NAME value) Sets the value of parameter 'name': specifies the name of the general factor extraction method to use.

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_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

KEY_MAXITER

public static final java.lang.String KEY_MAXITER

See Also:

Constant Field Values

KEY_EPSILON

public static final java.lang.String KEY_EPSILON

See Also:

Constant Field Values

KEY_ALGORITHM

public static final java.lang.String KEY_ALGORITHM

See Also:

Constant Field Values

Constructor Detail

MethodOptions

public MethodOptions()

MethodOptions

public MethodOptions(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

getName

public MethodOptions.NAME getName()

setName

public MethodOptions setName(MethodOptions.NAME value)

Sets the value of parameter 'name': specifies the name of the general factor extraction method to use. The server default is NAME.PCR.

Parameters:

value - The value

Returns:

The options object

getMaxIter

public java.lang.Integer getMaxIter()

setMaxIter

public MethodOptions setMaxIter(java.lang.Integer value)

Sets the value of parameter 'maxIter': specifies the maximum number of iterations for the NIPALS algorithm. The server default is 200.

Parameters:

value - The value

Returns:

The options object

getEpsilon

public java.lang.Double getEpsilon()

getEps

public java.lang.Double getEps()

setEpsilon

public MethodOptions setEpsilon(java.lang.Double value)

Sets the value of parameter 'epsilon': specifies the convergence criterion for the NIPALS algorithm. The server default is 1e-12.

Parameters:

value - The value

Returns:

The options object

setEps

public MethodOptions setEps(java.lang.Double value)

getAlgorithm

public MethodOptions.ALGORITHM getAlgorithm()

getAlg

public MethodOptions.ALGORITHM getAlg()

setAlgorithm

public MethodOptions setAlgorithm(MethodOptions.ALGORITHM value)

Sets the value of parameter 'algorithm': specifies the algorithm used to compute extracted PLS factors. The server default is ALGORITHM.NIPALS.

Parameters:

value - The value

Returns:

The options object

setAlg

public MethodOptions setAlg(MethodOptions.ALGORITHM value)