naginterfaces.library.lapackeig.dormlq

naginterfaces.library.lapackeig.dormlq(side, trans, a, tau, c)

dormlq multiplies an arbitrary real matrix $C$ by the real orthogonal matrix $Q$ from an $LQ$ factorization computed by dgelqf().

For full information please refer to the NAG Library document for f08ak

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/f08/f08akf.html

Parameters

sidestr, length 1

Indicates how $Q$ or $Q^T$ is to be applied to $C$.

$side=\text{'L'}$

$Q$ or $Q^T$ is applied to $C$ from the left.

$side=\text{'R'}$

$Q$ or $Q^T$ is applied to $C$ from the right.

transstr, length 1

Indicates whether $Q$ or $Q^T$ is to be applied to $C$.

$trans=\text{'N'}$

$Q$ is applied to $C$.

$trans=\text{'T'}$

$Q^T$ is applied to $C$.

afloat, array-like, shape $(k,:)$

Note: the required extent for this argument in dimension 2 is determined as follows: if $side=\text{'L'}$: $m$; if $side=\text{'R'}$: $n$; otherwise: $0$.

Details of the vectors which define the elementary reflectors, as returned by dgelqf().

taufloat, array-like, shape $\left(k\right)$

Further details of the elementary reflectors, as returned by dgelqf().

cfloat, array-like, shape $(m,n)$

The $m\times n$ matrix $C$.

Returns

cfloat, ndarray, shape $(m,n)$

$c$ is overwritten by $QC$ or $Q^{T}C$ or $CQ$ or $C{Q}^T$ as specified by $side$ and $trans$.

Raises

NagValueError

(errno $-1$)

On entry, error in parameter $side$.

Constraint: $side=\text{'L'}$ or $\text{'R'}$.

(errno $-2$)

On entry, error in parameter $trans$.

Constraint: $trans=\text{'N'}$ or $\text{'T'}$.

(errno $-3$)

On entry, error in parameter $\text{m}$.

Constraint: $m\ge 0$.

(errno $-4$)

On entry, error in parameter $\text{n}$.

Constraint: $n\ge 0$.

(errno $-5$)

On entry, error in parameter $\text{k}$.

Constraint: $m\ge k\ge 0$.

(errno $-5$)

On entry, error in parameter $\text{k}$.

Constraint: $n\ge k\ge 0$.

Notes

dormlq is intended to be used after a call to dgelqf(), which performs an $LQ$ factorization of a real matrix $A$. The orthogonal matrix $Q$ is represented as a product of elementary reflectors.

This function may be used to form one of the matrix products

$$QC,Q^{T}C,CQ\text{or}C{Q}^T\text{,}$$

overwriting the result on $C$ (which may be any real rectangular matrix).

References

Golub, G H and Van Loan, C F, 1996, Matrix Computations, (3rd Edition), Johns Hopkins University Press, Baltimore