dash.stateVectorVariable.design

Design the dimensions of a state vector variable

Syntax



obj = obj.design(dims, types, indices, header)

Description



obj = obj.design(dims, types, indices, header)

Designs the specified dimensions given the dimension types and state/reference indices for the dimensions.

Input Arguments

dims

vector, linear indices [nDimensions]
The indices of the dimensions to design.

types

vector, integers [nDimensions]
0 if a dimension should maintain its current state. 1 if a state dimension. 2 if an ensemble dimension.

indices

cell vector [nDimensions] {[] | logical vector | vector, linear indices}
State or reference indices for each dimension.

Output Arguments

obj

scalar dash.*stateVectorVariable* object
The variable updated with the new design parameters.