The Permute function applies the compact permutation stored in pvec to the mod m Matrix or Vector A in-place.

The pvec parameter must be a Vector of type integer[4]/integer[8], integer, or anything, and must have integer entries in the range , where  is the number of elements being permuted.

If rowflag is true, the permutation is applied to the rows of A.  If the number of elements in pvec is larger than the number of rows of A, then only the first  components of pvec are applied.

If rowflag is false, the permutation is applied to the columns of A. If the number of elements in pvec is larger than the number of columns of A, then only the first  components of pvec are applied.

If the invflag parameter is true, it indicates that the inverse of the permutation is to be applied.  If invflag is false, it indicates that the permutation itself is to be applied.

As mentioned before, the permutation must be stored in a compact form in pvec. This vector can be interpreted as an ordered list of instructions on how to apply a permutation, where the first entry describes the row exchange required for the first row, the second describes the row exchange required for the second row, etcetera.

For example, if, for a  Matrix, the permutation Vector is given by [1, 4, 4], then this corresponds to the following exchanges in the given order: , , .

Unlike a permutation Matrix, this format does not result in a unique representation for a permutation. For example, for a  Matrix, the identity permutation is given by [], [1], [2,1], [1,2,3], [3,2,1], [2,1,3], etcetera. Use of this format makes application of the permutation (or its inverse) to a Matrix or Vector quite simple. If the permutation Matrix is required, it can be obtained through application of the Permute function on an identity Matrix.

This function is most often used in combination with LUDecomposition and RowEchelonTransform, and is used in LUApply.

This command is part of the LinearAlgebra[Modular] package, so it can be used in the form Permute(..) only after executing the command with(LinearAlgebra[Modular]).  However, it can always be used in the form LinearAlgebra[Modular][Permute](..).