Optimizer.AddStateVariable(String, Variable, Variable, Variable, Variable, Variable) Method

Top 

Description

Creates a new entry in the Optimizer.StateVariables array with the specified label.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

Optimizer.AddStateVariable(

String label,


Variable initialGuess,


Variable lowerBound,


Variable upperBound,


Variable scale,


Variable perturbation)

 

 

Arguments

label


Description:

The label for this optimization variable.

 

 

initialGuess


Description:

The initial guess of the state variable value.

 

 

lowerBound


Description:

Lower bound associated with the state variable.

 

 

upperBound


Description:

Upper bound associated with the state variable.

 

 

scale


Description:

The scale used for the optimization variable.

Valid Range:

scale ≥ 0

 

 

perturbation


Description:

Perturbation associated with the state variable.

 

 

 

Return Value

Type:

number

 

 

Returns the updated number of optimization variables.

 

Syntax

myVariable1 = myOptimizer1.AddStateVariable(myString1, myVariable2, myVariable3, myVariable4, myVariable5, myVariable6);

 

 

See also

Optimizer Object

Optimizer.AddStateVariable