Optimizer.SetGradientSparsityValue(TrajectoryPhase, Variable, Array, Array) Method

Top 

Description

Sets value(s) in the Optimizer.GradientSparsity array corresponding to a set of TrajectoryPhase state variables.

 

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.SetGradientSparsityValue(

TrajectoryPhase trajectoryPhase,


Variable node,


Array stateIndices,


Array values)

 

 

Arguments

trajectoryPhase


Description:

The TrajectoryPhase object associated with the gradient sparsity values to set.

 

 

node


Description:

The index of the node point associated with the gradient sparsity values to set.

Valid Range:

node ≥ 0

 

 

stateIndices


Description:

The indices of the TrajectoryPhase node state vector associated with the gradient sparsity values to set. Indices: [ 0 : x, 1 : y, 2 : z, 3 : vx, 4 : vy, 5 : vz, 6 : mass, 7 : epoch, 8+ : control variables].

Required Size:

At least 1

 

 

values


Description:

The gradient sparsity values to set. Each array value must be in the set [-999 : Unknown, 0 : Always zero, 1 : Non-zero].]

Required Size:

At least 1

 

 

 

Syntax

myOptimizer1.SetGradientSparsityValue(myTrajectoryPhase1, myVariable1, myArray1, myArray2);

 

 

See also

Optimizer Object

Optimizer.SetGradientSparsityValue