Optimizer.SetGradientSparsityValue(String, Variable) Method

Top 

Description

Sets a value in the Optimizer.GradientSparsity array.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

 

Method Signature

Optimizer.SetGradientSparsityValue(

String stateVariableLabel,


Variable value)

 

 

Arguments

stateVariableLabel


Description:

The label corresponding to the associated StateVariable.

 

 

value


Description:

The gradient sparsity value to set

Valid Values:

Value

Label

-999

Unknown

0

Always zero

1

Non-zero

 

 

 

 

Syntax

myOptimizer1.SetGradientSparsityValue(myString1, myVariable1);

 

 

See also

Optimizer Object

Optimizer.SetGradientSparsityValue