NAG CL Interfacef16pmc (dger)

1Purpose

f16pmc performs a rank-1 update on a real general matrix.

2Specification

 #include
 void f16pmc (Nag_OrderType order, Nag_ConjType conj, Integer m, Integer n, double alpha, const double x[], Integer incx, const double y[], Integer incy, double beta, double a[], Integer pda, NagError *fail)
The function may be called by the names: f16pmc, nag_blast_dger or nag_dger.

3Description

f16pmc performs the rank-1 update operation
 $A←αxyT+βA,$
where $A$ is an $m$ by $n$ real matrix, $x$ is an $m$ element real vector, $y$ is an $n$-element real vector, and $\alpha$ and $\beta$ are real scalars. If $m$ or $n$ is equal to zero or if $\beta$ is equal to one and $\alpha$ is equal to zero, this function returns immediately.

4References

Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001) Basic Linear Algebra Subprograms Technical (BLAST) Forum Standard University of Tennessee, Knoxville, Tennessee https://www.netlib.org/blas/blast-forum/blas-report.pdf

5Arguments

1: $\mathbf{order}$Nag_OrderType Input
On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by ${\mathbf{order}}=\mathrm{Nag_RowMajor}$. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or $\mathrm{Nag_ColMajor}$.
2: $\mathbf{conj}$Nag_ConjType Input
On entry: the argument conj is not referenced if $x$ and $y$ are real vectors. It is suggested that you set ${\mathbf{conj}}=\mathrm{Nag_NoConj}$ where the elements ${y}_{i}$ are not conjugated.
Constraint: ${\mathbf{conj}}=\mathrm{Nag_NoConj}$.
3: $\mathbf{m}$Integer Input
On entry: $m$, the number of rows of the matrix $A$.
Constraint: ${\mathbf{m}}\ge 0$.
4: $\mathbf{n}$Integer Input
On entry: $n$, the number of columns of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
5: $\mathbf{alpha}$double Input
On entry: the scalar $\alpha$.
6: $\mathbf{x}\left[\mathit{dim}\right]$const double Input
Note: the dimension, dim, of the array x must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,1+\left({\mathbf{n}}-1\right)\left|{\mathbf{incx}}\right|\right)$.
On entry: the $n$-element vector $x$.
If ${\mathbf{incx}}>0$, ${x}_{\mathit{i}}$ must be stored in ${\mathbf{x}}\left[\left(\mathit{i}-1\right)×{\mathbf{incx}}\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{m}}$.
If ${\mathbf{incx}}<0$, ${x}_{\mathit{i}}$ must be stored in ${\mathbf{x}}\left[\left({\mathbf{m}}-\mathit{i}\right)×\left|{\mathbf{incx}}\right|\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{m}}$.
Intermediate elements of x are not referenced. If ${\mathbf{m}}=0$, x is not referenced and may be NULL.
7: $\mathbf{incx}$Integer Input
On entry: the increment in the subscripts of x between successive elements of $x$.
Constraint: ${\mathbf{incx}}\ne 0$.
8: $\mathbf{y}\left[\mathit{dim}\right]$const double Input
Note: the dimension, dim, of the array y must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,1+\left({\mathbf{n}}-1\right)\left|{\mathbf{incy}}\right|\right)$.
On entry: the $n$-element vector $y$.
If ${\mathbf{incy}}>0$, ${y}_{\mathit{i}}$ must be stored in ${\mathbf{y}}\left[\left(\mathit{i}-1\right)×{\mathbf{incy}}\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{n}}$.
If ${\mathbf{incy}}<0$, ${y}_{\mathit{i}}$ must be stored in ${\mathbf{y}}\left[\left({\mathbf{n}}-\mathit{i}\right)×\left|{\mathbf{incy}}\right|\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{n}}$.
Intermediate elements of y are not referenced. If $\alpha =0.0$ or ${\mathbf{n}}=0$, y is not referenced and may be NULL.
9: $\mathbf{incy}$Integer Input
On entry: the increment in the subscripts of y between successive elements of $y$.
Constraint: ${\mathbf{incy}}\ne 0$.
10: $\mathbf{beta}$double Input
On entry: the scalar $\beta$.
11: $\mathbf{a}\left[\mathit{dim}\right]$double Input/Output
Note: the dimension, dim, of the array a must be at least
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{pda}}×{\mathbf{n}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}×{\mathbf{pda}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
If ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(j-1\right)×{\mathbf{pda}}+i-1\right]$.
If ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(i-1\right)×{\mathbf{pda}}+j-1\right]$.
On entry: the $m$ by $n$ matrix $A$.
On exit: the updated matrix $A$.
12: $\mathbf{pda}$Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
• if ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$;
• if ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${\mathbf{pda}}\ge {\mathbf{n}}$.
13: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_INT
On entry, ${\mathbf{incx}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{incx}}\ne 0$.
On entry, ${\mathbf{incy}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{incy}}\ne 0$.
On entry, ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{m}}\ge 0$.
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
NE_INT_2
On entry, ${\mathbf{pda}}=〈\mathit{\text{value}}〉$, ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$.
On entry, ${\mathbf{pda}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pda}}\ge {\mathbf{n}}$.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7Accuracy

The BLAS standard requires accurate implementations which avoid unnecessary over/underflow (see Section 2.7 of Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001)).

8Parallelism and Performance

f16pmc is not threaded in any implementation.

The argument conj is not referenced in this case where $x$ and $y$ are real vectors.

10Example

Perform rank-1 update of real matrix $A$ using vectors $x$ and $y$:
 $A ← A - x yT ,$
where $A$ is the $3$ by $2$ matrix given by
 $A = 3.0 2.0 3.0 4.0 5.0 9.0 ,$
 $x = 2.0,3.0,5.0 T and y = 0.0,1.0,0.0 T .$

10.1Program Text

Program Text (f16pmce.c)

10.2Program Data

Program Data (f16pmce.d)

10.3Program Results

Program Results (f16pmce.r)