naginterfaces.library.lapackeig.zgeqpf¶
- naginterfaces.library.lapackeig.zgeqpf(a, jpvt)[source]¶
zgeqpf
computes the factorization, with column pivoting, of a complex matrix.zgeqpf
is marked as deprecated by LAPACK; the replacement routine iszgeqp3()
which makes better use of Level 3 BLAS.Deprecated since version 27.0.0.0:
zgeqpf
is deprecated. Please usezgeqp3()
instead. See also the Replacement Calls document.For full information please refer to the NAG Library document for f08bs
https://support.nag.com/numeric/nl/nagdoc_30.1/flhtml/f08/f08bsf.html
- Parameters
- acomplex, array-like, shape
The matrix .
- jpvtint, array-like, shape
If , the th column of is moved to the beginning of before the decomposition is computed and is fixed in place during the computation. Otherwise, the th column of is a free column (i.e., one which may be interchanged during the computation with any other free column).
- Returns
- acomplex, ndarray, shape
If , the elements below the diagonal are overwritten by details of the unitary matrix and the upper triangle is overwritten by the corresponding elements of the upper triangular matrix .
If , the strictly lower triangular part is overwritten by details of the unitary matrix and the remaining elements are overwritten by the corresponding elements of the upper trapezoidal matrix .
The diagonal elements of are real.
- jpvtint, ndarray, shape
Details of the permutation matrix . More precisely, if , the th column of is moved to become the th column of ; in other words, the columns of are the columns of in the order .
- taucomplex, ndarray, shape
Further details of the unitary matrix .
- Raises
- NagValueError
- (errno )
On entry, error in parameter .
Constraint: .
- (errno )
On entry, error in parameter .
Constraint: .
- Notes
zgeqpf
forms the factorization, with column pivoting, of an arbitrary rectangular complex matrix.If , the factorization is given by:
where is an upper triangular matrix (with real diagonal elements), is an unitary matrix and is an permutation matrix. It is sometimes more convenient to write the factorization as
which reduces to
where consists of the first columns of , and the remaining columns.
If , is trapezoidal, and the factorization can be written
where is upper triangular and is rectangular.
The matrix is not formed explicitly but is represented as a product of elementary reflectors (see the F08 Introduction for details). Functions are provided to work with in this representation (see Further Comments).
Note also that for any , the information returned in the first columns of the array represents a factorization of the first columns of the permuted matrix .
The function allows specified columns of to be moved to the leading columns of at the start of the factorization and fixed there. The remaining columns are free to be interchanged so that at the th stage the pivot column is chosen to be the column which maximizes the -norm of elements to over columns to .
- References
Golub, G H and Van Loan, C F, 1996, Matrix Computations, (3rd Edition), Johns Hopkins University Press, Baltimore