LUDecomposition<T>.ApplyP Method

Definition

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

ApplyP(Matrix<T>) Applies the permutation P of the decomposition PA= LU to a Matrix<T> and returns the result as a DenseMatrix<T>.
Obsolete.
ApplyP(Vector<T>) Applies the permutation P of the decomposition PA= LU to a Vector<T>.
Obsolete.
ApplyP(DenseMatrix<T>, Boolean) Applies the permutation P of the decomposition PA= LU to a DenseMatrix<T>.
Obsolete.
ApplyP(Vector<T>, Boolean) Applies the permutation P of the decomposition PA= LU to a Vector<T>.
Obsolete.

ApplyP(Matrix<T>)

Note: This API is now obsolete.
Applies the permutation P of the decomposition PA= LU to a Matrix<T> and returns the result as a DenseMatrix<T>.
C# 
[ObsoleteAttribute("Use RowPermutation.Apply instead.")]
public DenseMatrix<T> ApplyP(
	Matrix<T> matrix
)

Parameters

matrix  Matrix<T>
A Matrix<T> with length equal to the number of rows in the underlying Matrix<T>.

Return Value

DenseMatrix<T>
The DenseMatrix<T>matrix with its elements permuted.

Exceptions

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

ApplyP(Vector<T>)

Note: This API is now obsolete.
Applies the permutation P of the decomposition PA= LU to a Vector<T>.
C# 
[ObsoleteAttribute("Use RowPermutation.Apply instead.")]
public Vector<T> ApplyP(
	Vector<T> vector
)

Parameters

vector  Vector<T>
A Vector<T> with length equal to the number of rows in the underlying DenseMatrix<T>.

Return Value

Vector<T>
The Vector<T>vector with its elements permuted.

Exceptions

ArgumentNullExceptionvector is null.
DimensionMismatchExceptionThe length of vector does not equal the number of rows in the permutation matrix.

ApplyP(DenseMatrix<T>, Boolean)

Note: This API is now obsolete.
Applies the permutation P of the decomposition PA= LU to a DenseMatrix<T>.
C# 
[ObsoleteAttribute("Use RowPermutation.Apply instead.")]
public DenseMatrix<T> ApplyP(
	DenseMatrix<T> matrix,
	bool overwrite
)

Parameters

matrix  DenseMatrix<T>
A DenseMatrix<T> with length equal to the number of rows in the underlying DenseMatrix<T>.
overwrite  Boolean
If true, the vector matrix is overwritten by the result. If false, a new DenseMatrix<T> is returned.

Return Value

DenseMatrix<T>
A DenseMatrix<T> with the elements of matrix permuted.

Remarks

Note that the first parameter must be a DenseMatrix<T>. This is because this is the only matrix type whose elements are guaranteed to be all writable.

Exceptions

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

ApplyP(Vector<T>, Boolean)

Note: This API is now obsolete.
Applies the permutation P of the decomposition PA= LU to a Vector<T>.
C# 
[ObsoleteAttribute("Use RowPermutation.Apply instead.")]
public Vector<T> ApplyP(
	Vector<T> vector,
	bool overwrite
)

Parameters

vector  Vector<T>
A Vector<T> with length equal to the number of rows in the underlying DenseMatrix<T>.
overwrite  Boolean
If true, the vector vector is overwritten by the result. If false, a new Vector<T> is returned.

Return Value

Vector<T>
A Vector<T> with the elements of vector permuted.

Exceptions

ArgumentNullExceptionvector is null.
DimensionMismatchExceptionThe length of vector does not equal the number of rows in the permutation matrix.

See Also