Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

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

Document Table of Contents

?symv

Computes a matrix-vector product for a symmetric matrix.

Syntax

call ssymv(uplo, n, alpha, a, lda, x, incx, beta, y, incy)

call dsymv(uplo, n, alpha, a, lda, x, incx, beta, y, incy)

call symv(a, x, y [,uplo][,alpha] [,beta])

Include Files

  • mkl.fi, blas.f90

Description

The ?symv routines perform a matrix-vector operation defined as

y := alpha*A*x + beta*y,

where:

alpha and beta are scalars,

x and y are n-element vectors,

A is an n-by-n symmetric matrix.

Input Parameters

uplo

CHARACTER*1. Specifies whether the upper or lower triangular part of the array a is used.

If uplo = 'U' or 'u', then the upper triangular part of the array a is used.

If uplo = 'L' or 'l', then the low triangular part of the array a is used.

n

INTEGER. Specifies the order of the matrix A. The value of n must be at least zero.

alpha

REAL for ssymv

DOUBLE PRECISION for dsymv

Specifies the scalar alpha.

a

REAL for ssymv

DOUBLE PRECISION for dsymv

Array, size (lda, n).

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

lda

INTEGER. Specifies the leading dimension of a as declared in the calling (sub)program. The value of lda must be at least max(1, n).

x

REAL for ssymv

DOUBLE PRECISION for dsymv

Array, size at least (1 + (n - 1)*abs(incx)). Before entry, the incremented array x must contain the n-element vector x.

incx

INTEGER. Specifies the increment for the elements of x.

The value of incx must not be zero.

beta

REAL for ssymv

DOUBLE PRECISION for dsymv

Specifies the scalar beta.

When beta is supplied as zero, then y need not be set on input.

y

REAL for ssymv

DOUBLE PRECISION for dsymv

Array, size at least (1 + (n - 1)*abs(incy)). Before entry, the incremented array y must contain the n-element vector y.

incy

INTEGER. Specifies the increment for the elements of y.

The value of incy must not be zero.

Output Parameters

y

Overwritten by the updated vector y.

BLAS 95 Interface Notes

Routines in Fortran 95 interface have fewer arguments in the calling sequence than their FORTRAN 77 counterparts. For general conventions applied to skip redundant or reconstructible arguments, see BLAS 95 Interface Conventions.

Specific details for the routine symv interface are the following:

a

Holds the matrix A of size (n,n).

x

Holds the vector with the number of elements n.

y

Holds the vector with the number of elements n.

uplo

Must be 'U' or 'L'. The default value is 'U'.

alpha

The default value is 1.

beta

The default value is 0.