dash.stateVectorVariable.stateSizes
Returns the sizes and names of state dimensions
Syntax
Description
sizes = obj.stateSizes
Return the lengths of dimensions with a non-trivial number of state vector elements. Non-trivial dimensions are all state dimensions (even if taking a mean), and ensemble dimensions with sequences.
Also return a string identifying the dimension and any details associated with each dimension length. For state dimensions, “<dim>”. For state dimensions with a mean “<dim> mean”. For sequences, uses “<dim> sequence”.
Output Arguments
sizes
vector, positive integers [nDimensions]
The lengths of all dimensions with a non-trivial state vector length.
types
string vector [nDimensions]
Dimension name and details associated with each state vector length.