Applies the permutation P of the decomposition PA= LU to a GeneralMatrix.

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Function ApplyP ( _
	matrix As GeneralMatrix, _
	overwrite As Boolean _
) As GeneralMatrix
C#
public GeneralMatrix ApplyP (
	GeneralMatrix matrix,
	bool overwrite
)
C++
public:
GeneralMatrix^ ApplyP (
	GeneralMatrix^ matrix, 
	bool overwrite
)

Parameters

matrix (Extreme.Mathematics.LinearAlgebra.GeneralMatrix)
A GeneralMatrix with length equal to the number of rows in the underlying GeneralMatrix.
overwrite (System.Boolean)
If true, the vector matrix is overwritten by the result. If false, a new GeneralMatrix is returned.

Return Value

A GeneralMatrix with the elements of matrix permuted.

Remarks

Note that the first parameter must be a GeneralMatrix. This is because this is the only matrix type whose elements are guaranteed to be all writeable.

Exceptions

ExceptionCondition
ArgumentNullExceptionmatrix is nullNothingnullptr.
DimensionMismatchExceptionThe number of rows in matrix does not equal the number of rows in the permutation matrix.