p?syntrd

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 10/31/2024

Version

Public

Visible to Intel only — GUID: GUID-1760738E-5820-4B7C-8128-FF2D3F3631E3

View Details

p?syntrd

Reduces a real symmetric matrix to symmetric tridiagonal form.

Syntax

void pssyntrd (const char* uplo, const MKL_INT* n, float* a, const MKL_INT* ia, const MKL_INT* ja, const MKL_INT* desca, float* d, float* e, float* tau, float* work, const MKL_INT* lwork, MKL_INT* info);

void pdsyntrd (const char* uplo, const MKL_INT* n, double* a, const MKL_INT* ia, const MKL_INT* ja, const MKL_INT* desca, double* d, double* e, double* tau, double* work, const MKL_INT* lwork, MKL_INT* info);

Include Files

mkl_scalapack.h

Description

p?syntrd is a prototype version of p?sytrd which uses tailored codes (either the serial, ?sytrd, or the parallel code, p?syttrd) when the workspace provided by the user is adequate.

p?syntrd reduces a real symmetric matrix sub( A ) to symmetric tridiagonal form T by an orthogonal similarity transformation:

Q' * sub( A ) * Q = T, where sub( A ) = A(ia:ia+n-1,ja:ja+n-1).

Features

p?syntrd is faster than p?sytrd on almost all matrices, particularly small ones (i.e. n < 500 * sqrt(P) ), provided that enough workspace is available to use the tailored codes.

The tailored codes provide performance that is essentially independent of the input data layout.

The tailored codes place no restrictions on ia, ja, MB or NB. At present, ia, ja, MB and NB are restricted to those values allowed by p?hetrd to keep the interface simple (see the Application Notes section for more information about the restrictions).

Input Parameters

uplo

(global)

Specifies whether the upper or lower triangular part of the symmetric matrix sub( A ) is stored:

= 'U': Upper triangular

= 'L': Lower triangular

n

(global)

The number of rows and columns to be operated on, i.e. the order of the distributed submatrix sub( A ). n >= 0.

a

(local)

Pointer into the local memory to an array of size lld_a*LOCc(ja+n-1).

On entry, this array contains the local pieces of the symmetric distributed matrix sub( A ). If uplo = 'U', the leading n-by-n upper triangular part of sub( A ) contains the upper triangular part of the matrix, and its strictly lower triangular part is not referenced. If uplo = 'L', the leading n-by-n lower triangular part of sub( A ) contains the lower triangular part of the matrix, and its strictly upper triangular part is not referenced.

ia

(global)

The row index in the global array a indicating the first row of sub( A ).

ja

(global)

The column index in the global array a indicating the first column of sub( A ).

desca

(global and local)

Array of size dlen_.

The array descriptor for the distributed matrix A.

work

(local)

Array, size (lwork)

lwork

(local or global)

The size of the array work.

lwork is local input and must be at least lwork >= MAX( NB * ( NP +1 ), 3 * NB )

For optimal performance, greater workspace is needed, i.e.

lwork >= 2*( ANB+1 )*( 4*NPS+2 ) + ( NPS + 4 ) * NPS

ANB = pjlaenv( ICTXT, 3, 'p?syttrd', 'L', 0, 0, 0, 0 )

ICTXT = desca( ctxt_ )

SQNPC = INT( sqrt( REAL( NPROW * NPCOL ) ) )

numroc is a ScaLAPACK tool function.

pjlaenv is a ScaLAPACK environmental inquiry function.

NPROW and NPCOL can be determined by calling the subroutine blacs_gridinfo.

Output Parameters

a	On exit, if uplo = 'U', the diagonal and first superdiagonal of sub( `A` ) are overwritten by the corresponding elements of the tridiagonal matrix `T`, and the elements above the first superdiagonal, with the array tau, represent the orthogonal matrix `Q` as a product of elementary reflectors; if uplo = 'L', the diagonal and first subdiagonal of sub( `A` ) are overwritten by the corresponding elements of the tridiagonal matrix `T`, and the elements below the first subdiagonal, with the array tau, represent the orthogonal matrix `Q` as a product of elementary reflectors. See Further Details.
d	(local) Array, size LOCc(ja+n-1) The diagonal elements of the tridiagonal matrix `T`: d(i) = `A`(i,i). d is tied to the distributed matrix `A`.
e	(local) Array, size LOCc(ja+n-1) if uplo = 'U', LOCc(ja+n-2) otherwise. The off-diagonal elements of the tridiagonal matrix `T`: e(i) = `A`(i,i+1) if uplo = 'U', e(i) = `A`(i+1,i) if uplo = 'L'. e is tied to the distributed matrix `A`.
tau	(local) Array, size LOCc(ja+n-1). This array contains the scalar factors tau of the elementary reflectors. tau is tied to the distributed matrix `A`.
work	(local) Array, size (lwork) On exit, work`[0]` returns the optimal lwork.
info	(global) = 0: successful exit < 0: If the `i`-th argument is an array and the `j`-th entry had an illegal value, then info = -(`i`*100+`j`), if the `i`-th argument is a scalar and had an illegal value, then info = -`i`.

Application Notes

If uplo = 'U', the matrix Q is represented as a product of elementary reflectors

Q = H(n-1) . . . H(2) H(1).

Each H(i) has the form

H(i) = I - tau * v * v', where tau is a complex scalar, and v is a complex vector with v(i+1:n) = 0 and v(i) = 1; v(1:i-1) is stored on exit in A(ia:ia+i-2,ja+i), and tau in tau(ja+i-1).

If uplo = 'L', the matrix Q is represented as a product of elementary reflectors

Q = H(1) H(2) . . . H(n-1).

Each H(i) has the form

H(i) = I - tau * v * v', where tau is a complex scalar, and v is a complex vector with v(1:i) = 0 and v(i+1) = 1; v(i+2:n) is stored on exit in A(ia+i+1:ia+n-1,ja+i-1), and tau in tau(ja+i-1).

The contents of sub( A ) on exit are illustrated by the following examples with n = 5:

if uplo = 'U':

if uplo = 'L':

where d and e denote diagonal and off-diagonal elements of T, and vi denotes an element of the vector defining H(i).

Alignment requirements

The distributed submatrix sub( A ) must verify some alignment properties, namely the following expression should be true:

( mb_a = nb_a and IROFFA = ICOFFA and IROFFA = 0 ) with IROFFA = mod( ia-1, mb_a), and ICOFFA = mod( ja-1, nb_a ).

Parent topic: Symmetric Eigenvalue Problems: ScaLAPACK Computational 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 C

p?syntrd

Syntax

Include Files

Description

Input Parameters

Output Parameters

Application Notes