?gsvj1

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 11/07/2023

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-6D86E777-A72C-4BED-A8B5-FB7822E23497

View Details

?gsvj1

Pre-processor for the routine ?gesvj, applies Jacobi rotations targeting only particular pivots.

Syntax

call sgsvj1(jobv, m, n, n1, a, lda, d, sva, mv, v, ldv, eps, sfmin, tol, nsweep, work, lwork, info)

call dgsvj1(jobv, m, n, n1, a, lda, d, sva, mv, v, ldv, eps, sfmin, tol, nsweep, work, lwork, info)

call cgsvj1(jobv, m, n, n1, a, lda, d, sva, mv, v, ldv, eps, sfmin, tol, nsweep, work, lwork, info)

call zgsvj1(jobv, m, n, n1, a, lda, d, sva, mv, v, ldv, eps, sfmin, tol, nsweep, work, lwork, info)

Include Files

mkl.fi

Description

This routine is called from ?gesvj as a pre-processor and that is its main purpose. It applies Jacobi rotations in the same way as ?gesvj does, but it targets only particular pivots and it does not check convergence (stopping criterion).

The routine ?gsvj1 applies few sweeps of Jacobi rotations in the column space of the input m-by-n matrix A. The pivot pairs are taken from the (1,2) off-diagonal block in the corresponding n-by-n Gram matrix A'*A. The block-entries (tiles) of the (1,2) off-diagonal block are marked by the [x]'s in the following scheme:

row-cycling in the nblr-by-nblc[x] blocks, row-cyclic pivoting inside each [x] block

In terms of the columns of the matrix A, the first n1 columns are rotated 'against' the remaining n-n1 columns, trying to increase the angle between the corresponding subspaces. The off-diagonal block is n1-by-(n-n1) and it is tiled using quadratic tiles. The number of sweeps is specified by nsweep, and the orthogonality threshold is set by tol.

Input Parameters

jobv

CHARACTER*1. Must be 'V', 'A', or 'N'.

Specifies whether the output from this routine is used to compute the matrix V.

If jobv = 'V', the product of the Jacobi rotations is accumulated by post-multiplying the n-by-n array v.

If jobv = 'A', the product of the Jacobi rotations is accumulated by post-multiplying the mv-by-n array v.

If jobv = 'N', the Jacobi rotations are not accumulated.

m

INTEGER. The number of rows of the input matrix A (m≥ 0).

n

INTEGER. The number of columns of the input matrix B (m≥n≥ 0).

n1

INTEGER. Specifies the 2-by-2 block partition. The first n1 columns are rotated 'against' the remaining n-n1 columns of the matrix A.

a

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

COMPLEX for cgsvj1

DOUBLE COMPLEX for zgsvj1.

Array, DIMENSION (lda, n). Contains the m-by-n matrix A, such that A*diag(D) represents the input matrix.

lda

INTEGER. The leading dimension of a; at least max(1, m).

d

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

COMPLEX for cgsvj1

DOUBLE COMPLEX for zgsvj1.

Arrays, DIMENSION (n). Contains the diagonal matrix D that accumulates the scaling factors from the fast scaled Jacobi rotations. On entry A*diag(D) represents the input matrix.

sva

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

REAL for cgsvj1

DOUBLE PRECISION for zgsvj1.

Arrays, DIMENSION (n). Contains the Euclidean norms of the columns of the matrix A*diag(D).

mv

INTEGER. The leading dimension of b; at least max(1, p).

If jobv = 'A', then mv rows of v are post-multiplied by a sequence of Jacobi rotations.

If jobv = 'N', then mv is not referenced .

v

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

COMPLEX for cgsvj1

DOUBLE COMPLEX for zgsvj1.

Array, DIMENSION (ldv, n).

If jobv = 'V', then n rows of v are post-multiplied by a sequence of Jacobi rotations.

If jobv = 'A', then mv rows of v are post-multiplied by a sequence of Jacobi rotations.

If jobv = 'N', then v is not referenced.

ldv

INTEGER. The leading dimension of the array v; ldv≥ 1

ldv≥ n if jobv = 'V';

ldv≥ mv if jobv = 'A'.

eps

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

REAL for cgsvj1

DOUBLE PRECISION for zgsvj1.

The relative machine precision (epsilon) returned by the routine ?lamch.

sfmin

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

REAL for cgsvj1

DOUBLE PRECISION for zgsvj1.

Value of safe minimum returned by the routine ?lamch.

tol

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

REAL for cgsvj1

DOUBLE PRECISION for zgsvj1.

The threshold for Jacobi rotations. For a pair A(:,p), A(:,q) of pivot columns, the Jacobi rotation is applied only if abs(cos(angle(A(:,p),A(:,q))))> tol.

nsweep

INTEGER.

The number of sweeps of Jacobi rotations to be performed.

work

REAL for sgsvj1

DOUBLE PRECISION for dgsvj1.

COMPLEX for cgsvj1

DOUBLE COMPLEX for zgsvj1.

Workspace array, DIMENSION (lwork).

lwork

INTEGER. The size of the array work; at least max(1, m).

Output Parameters

a

On exit, A*diag(D) represents the input matrix post-multiplied by a sequence of Jacobi rotations, where the rotation threshold and the total number of sweeps are given in tol and nsweep, respectively

d

sva

On exit, contains the Euclidean norms of the columns of the output matrix A*diag(D).

v

If jobv = 'V', then n rows of v are post-multiplied by a sequence of Jacobi rotations.

If jobv = 'A', then mv rows of v are post-multiplied by a sequence of Jacobi rotations.

If jobv = 'N', then v is not referenced.

info

INTEGER.

If info = 0, the execution is successful.

If info = -i, the i-th parameter had an illegal value.

Parent topic: LAPACK Auxiliary Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

?gsvj1

Syntax

Include Files

Description

Input Parameters

Output Parameters