p?syr2

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 3/31/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-7FAF01D7-0A66-4329-AC90-A2B3BD1658C0

View Details

p?syr2

Performs a rank-2 update of a distributed symmetric matrix.

Syntax

void pssyr2 (const char *uplo , const MKL_INT *n , const float *alpha , const float *x , const MKL_INT *ix , const MKL_INT *jx , const MKL_INT *descx , const MKL_INT *incx , const float *y , const MKL_INT *iy , const MKL_INT *jy , const MKL_INT *descy , const MKL_INT *incy , float *a , const MKL_INT *ia , const MKL_INT *ja , const MKL_INT *desca );

void pdsyr2 (const char *uplo , const MKL_INT *n , const double *alpha , const double *x , const MKL_INT *ix , const MKL_INT *jx , const MKL_INT *descx , const MKL_INT *incx , const double *y , const MKL_INT *iy , const MKL_INT *jy , const MKL_INT *descy , const MKL_INT *incy , double *a , const MKL_INT *ia , const MKL_INT *ja , const MKL_INT *desca );

Include Files

mkl_pblas.h

Description

The p?syr2 routines perform a distributed matrix-vector operation defined as

sub(A) := alpha*sub(x)*sub(y)'+ alpha*sub(y)*sub(x)' + sub(A),

where:

alpha is a scalar,

sub(A) is a n-by-n distributed symmetric matrix, sub(A)=A(ia:ia+n-1, ja:ja+n-1) ,

sub(x) and sub(y) are distributed vectors.

sub(x) denotes X(ix, jx:jx+n-1) if incx = m_x, and X(ix: ix+n-1, jx) if incx = 1,

sub(y) denotes Y(iy, jy:jy+n-1) if incy = m_y, and Y(iy: iy+n-1, jy) if incy = 1.

Input Parameters

uplo

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

If uplo = 'U' or 'u', then the upper triangular part of the sub(A) is used.

If uplo = 'L' or 'l', then the low triangular part of the sub(A) is used.

n

(global) Specifies the order of the distributed matrix sub(A), n≥ 0.

alpha

(global)

Specifies the scalar alpha.

x

(local)

Array, size at least (jx-1)*m_x + ix+(n-1)*abs(incx)).

This array contains the entries of the distributed vector sub(x).

ix, jx

(global) The row and column indices in the distributed matrix X indicating the first row and the first column of the submatrix sub(x), respectively.

descx

(global and local) array of dimension 9. The array descriptor of the distributed matrix X.

incx

(global) Specifies the increment for the elements of sub(x). Only two values are supported, namely 1 and m_x. incx must not be zero.

y

(local)

Array, size at least (jy-1)*m_y + iy+(n-1)*abs(incy)).

This array contains the entries of the distributed vector sub(y).

iy, jy

(global) The row and column indices in the distributed matrix Y indicating the first row and the first column of the submatrix sub(y), respectively.

descy

(global and local) array of dimension 9. The array descriptor of the distributed matrix Y.

incy

(global) Specifies the increment for the elements of sub(y). Only two values are supported, namely 1 and m_y. incy must not be zero.

a

(local)

Array, size (lld_a, LOCq(ja+n-1)). This array contains the local pieces of the distributed matrix sub(A).

Before entry with uplo = 'U' or 'u', the n-by-n upper triangular part of the distributed matrix sub(A) must contain the upper triangular part of the distributed symmetric matrix and the strictly lower triangular part of sub(A) is not referenced, and with uplo = 'L' or 'l', the n-by-n lower triangular part of the distributed matrix sub(A) must contain the lower triangular part of the distributed symmetric matrix and the strictly upper triangular part of sub(A) is not referenced.

ia, ja

(global) The row and column indices in the distributed matrix A indicating the first row and the first column of the submatrix sub(A), respectively.

desca

(global and local) array of dimension 9. The array descriptor of the distributed matrix A.

Output Parameters

a

With uplo = 'U' or 'u', the upper triangular part of the array a is overwritten by the upper triangular part of the updated distributed matrix sub(A).

With uplo = 'L' or 'l', the lower triangular part of the array a is overwritten by the lower triangular part of the updated distributed matrix sub(A).

Parent topic: PBLAS Level 2 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?syr2