Name
|
Description
|
AddConstraint
|
Creates a new entry in the Optimizer.Constraints array with the specified label.
|
AddConstraintBlock
|
Adds a block of Constraints.
|
AddStateVariable
|
Creates a new entry in the Optimizer.StateVariables array with the specified label.
|
AddStateVariableBlock
|
Creates n new entries in the Optimizer.StateVariables array. Label is used as a prefix to create incremented labels for each entry.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
FeasibleSolutionFound
|
Returns 1 if the optimizer is has found a feasible solution, otherwise returns 0. This assessment is based on the ConstraintTolerance Optimizer property.
|
GetBestConstraintValue
|
Returns the value of the specified constraint corresponding to the best solution found so far. Calling this method before a feasible result is found will return -999.
|
GetBestConstraintValues
|
Returns an array containing the values of the constraints corresponding to the best found solution so far. Calling this method before a feasible result is found will return an empty array.
|
GetBestObjectiveFunctionValue
|
Returns objective function value corresponding to the best feasible solution found so far. Calling this method before a feasible result is found will return a value of -999.
|
GetBestSolutionMaximumInfeasibility
|
Returns the maximum scaled infeasibility of the current best solution. Calling this method before a feasible solution is found will return -999.
|
GetBestStateVariableValue
|
Returns the value of the specified state variable corresponding to the best solution found so far. Calling this method before a feasible result is found will return -999.
|
GetBestStateVariableValues
|
Returns an array containing the values of the state variables corresponding to the best solution found so far. Calling this method before a feasible result is found will return an empty array.
|
GetConstraint
|
Gets a reference to the Constraint associated with the specified label. If no Constraint is associated with that label, an error is reported.
|
GetConstraintIndex
|
Returns the index of the Constraint with the specified label, or -1 if the entry is not found.
|
GetConstraintValue
|
Returns the current value of the requested constraint.
|
GetConstraintValues
|
Returns an array of the most recent values for the constraints that have been evaluated.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
GetStateVariable
|
Gets a reference to the StateVariable associated with the specified label. If no StateVariable is associated with that label, an error is reported.
|
GetStateVariableIndex
|
Returns the index of the StateVariable with the specified label, or -1 if the entry is not found.
|
GetStateVariableValue
|
Returns the current value of the requested state variable. The current value is obtained from the third party optimization engine, and is updated upon every call to Minimize/Maximize.
|
GetStateVariableValues
|
Returns an array of the most recent values for the state variables that have been evaluated.
|
HasNotConverged
|
Returns 0 if the optimization engine has indicated that it has converged, otherwise returns 1. If the optimizer exits with a non-converged return code, an error occurs.
|
IsFeasible
|
Returns 1 if the current evaluation is feasible, otherwise returns 0. This assessment is based on the ConstraintTolerance Optimizer property.
|
IsRunning
|
Returns 1 if the optimizer is currently running, otherwise returns 0.
|
LoadEngine
|
Loads and initializes the third party engine to be used in the optimization process. At this time, the engine is configured to process the specified state variables and constraints.
|
Maximize
|
Process the evaluated constraints and the specified objective function value to be maximized.
|
Minimize
|
Process the evaluated constraints and the specified objective function value to be minimized.
|
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.
|
Reset
|
Resets the optimization process. The provided argument specifies whether the reset operation is partial or complete.
|
Restore
|
Restore an object's state from a previously saved state.
|
RestoreObjectsInProcess
|
Restores all objects that have been saved using the Optimizer.SaveObjectToProcess() method.
|
Save
|
Save the object's state so that it can be restored later.
|
SaveObjectToProcess
|
Saves the initial state of the object. The object will be restored to this initial state whenever the Optimizer.RestoreObjectsInProcess() method is called.
|
SetConstraintValue
|
Sets the value of the specified constraint.
|
SetConstraintValues
|
Sets the constraint values from an array. The constraintValues array must be of the same length as the optimizer's current Constraints array.
|
SetGradientValue
|
Sets the value of the element of the Gradient that is associated with the specified StateVariable.
|
SetInitialGuess
|
Sets the initial guess to be used by the optimizer. The initialGuessValues array must be of the same length as the optimizer's current StateVariables array.
|
SetJacobianValue
|
Sets the value of the element of the Jacobian that is associated with the specified Constraint/StateVariable pair.
|
SolveConstraints
|
Process the evaluated constraints and solve them without respect to an objective function.
|
UpdateStateVariables
|
Retrieves the next iteration of state variable values from the optimization process and stores them in the Optimizer object so that they can be subsequently used for evaluating the constraints and objective function. A call to this method should be placed at the top of the optimizer evaluation loop.
|