OptimizationStateVariable Object

The OptimizationStateVariable object allows the user to access properties of any state variable being used in an optimization process. This object is not creatable in script, but can be added to an Optimizer object as seen in the example below. OptimizationStateVariables that have been added to an Optimizer object can be accessed through properties and methods on the Optimizer object. See the Optimization Guide for more information.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
InitialGuess	The initial guess, or starting value, of the state variable.	Type: Variable Access: Read/Write
Label	The label for this optimization state variable.	Type: String Access: Read-Only
LowerBound	Lower bound associated with the state variable.	Type: Variable Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Perturbation	Perturbation associated with the state variable. This is used when evaluating finite differences to compute the Jacobian of the constraints and the gradient of the objective function.	Type: Variable Access: Read/Write
Scale	The scale factor used for the optimization variable. This can be used to normalize state variable values to be the same order of magnitude to preserve better matrix conditioning.	Type: Variable Access: Read/Write
UpperBound	Upper bound associated with the state variable.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
Lock	Locks the StateVariable, effectively removing it from the optimization process.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

OptimizationStateVariable Object

Description

Available In Editions:

Timing Precision Mode