checkIndexDimensions

Method of mss.

Assert that the model’s index vectors cover the tensor exactly.

Source: src/model/@mss/checkIndexDimensions.m

Syntax

checkIndexDimensions(sys)
sys.checkIndexDimensions()

Description

checkIndexDimensions is the sanity check run at the end of every mss construction path. An mss describes its signals and equations by index vectors rather than by fixed blocks, so nothing else guarantees that those vectors and the tensor agree. The method asserts two identities:

$$\underbrace{|\texttt{stateIndex}| + |\texttt{inputIndex}|}_{\text{signal rows}} = n_\text{var}, \qquad \underbrace{|\texttt{stateEquationIndex}| + |\texttt{outputEquationIndex}|}_{\text{equation rows}} = n_\text{eq}.$$

Where $n_\text{var}$ and $n_\text{eq}$ come from depends on the tensor:

Any other tensor class raises "Unsupported tensor type.". A mismatch raises an assertion naming both counts; the usual causes are a hand-written index vector that does not match the matrices it indexes, or a state/output equation split that leaves parameter rows unaccounted for.

The method returns nothing — it either passes silently or errors.

Input arguments

Example

sys = rmss(3,1,1,4);          % random 3-state, 1-input, 1-output model
sys.checkIndexDimensions();   % passes silently

See also

mss · allSignalScalarIndices · allEquationScalarIndices · checkIndexDimensions

MyToolbox Documentation | Generated automatically by CI/CD pipeline