allSignalScalarIndices

Method of mss.

Test whether every signal and equation index vector of the model holds a single row.

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

Syntax

result = allSignalScalarIndices(sys)

Description

allSignalScalarIndices returns true only when all four index vectors of the model are scalars: the signal indices stateIndex and inputIndex, and the equation indices stateEquationIndex and outputEquationIndex. It therefore also covers what allEquationScalarIndices checks.

Like its equation-only counterpart it is a constructor helper rather than a user-facing query. The mss constructor combines it with a size check against the structure matrix to decide whether a pair of scalars means “one state and one input” or “amountState states and amountInput inputs”; in the latter case the scalars are expanded into sequential index vectors covering the structure-matrix rows in order.

Input arguments

Argument Description
sys The mss model.

Output arguments

Output Description
result Logical scalar, true if stateIndex, inputIndex, stateEquationIndex and outputEquationIndex are all scalar.

See also

mss · allEquationScalarIndices · checkIndexDimensions


MyToolbox Documentation | Generated automatically by CI/CD pipeline