permuteEqualities

Method of mdss.

Apply a permutation to the model’s equality equations (rows).

Source: src/model/@mdss/permuteEqualities.m

Syntax

sysOut = permuteEqualities(sys, p)

Description

permuteEqualities reorders the equality equations of the model by the permutation p. It applies p to the equation (row) dimension of the three CP parameter matrices — parameterMatrixContinuous, parameterMatrixOne and parameterMatrixMinusOne — leaving the structure matrices unchanged.

p must be a valid permutation of 1:nEquality; a vector of the wrong length or one that is not a permutation raises an error. This method carries out the actual row reordering computed by orderEqualities.

Input arguments

Argument Description
sys The mdss model whose equations are permuted.
p Permutation vector, a rearrangement of 1:nEquality.

Output arguments

Output Description
sysOut The mdss model with its equality equations reordered by p.

Example

% Reverse the order of a 3-equation model's equalities
sysOut = permuteEqualities(sys, [3 2 1]);

See also

mdss · orderEqualities · determineParallizedSolvingOrder


MyToolbox Documentation | Generated automatically by CI/CD pipeline