?tbmv

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 12/16/2022

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-83E7A0D2-13EB-4003-A875-A538CBBCCC40

View Details

?tbmv

Computes a matrix-vector product using a triangular band matrix.

Syntax

call stbmv(uplo, trans, diag, n, k, a, lda, x, incx)

call dtbmv(uplo, trans, diag, n, k, a, lda, x, incx)

call ctbmv(uplo, trans, diag, n, k, a, lda, x, incx)

call ztbmv(uplo, trans, diag, n, k, a, lda, x, incx)

call tbmv(a, x [,uplo] [, trans] [,diag])

Include Files

mkl.fi, blas.f90

Description

The ?tbmv routines perform one of the matrix-vector operations defined as

x := A*x, or x := A'*x, or x := conjg(A')*x,

where:

x is an n-element vector,

A is an n-by-n unit, or non-unit, upper or lower triangular band matrix, with (k +1) diagonals.

Input Parameters

uplo

CHARACTER*1. Specifies whether the matrix A is an upper or lower triangular matrix:

uplo = 'U' or 'u'

if uplo = 'L' or 'l', then the matrix is low triangular.

trans

CHARACTER*1. Specifies the operation:

if trans= 'N' or 'n', then x := A*x;

if trans= 'T' or 't', then x := A'*x;

if trans= 'C' or 'c', then x := conjg(A')*x.

diag

CHARACTER*1. Specifies whether the matrix A is unit triangular:

if uplo = 'U' or 'u' then the matrix is unit triangular;

if diag = 'N' or 'n', then the matrix is not unit triangular.

n

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

k

INTEGER. On entry with uplo = 'U' or 'u' specifies the number of super-diagonals of the matrix A. On entry with uplo = 'L' or 'l', k specifies the number of sub-diagonals of the matrix a.

The value of k must satisfy 0≤k.

a

REAL for stbmv

DOUBLE PRECISION for dtbmv

COMPLEX for ctbmv

DOUBLE COMPLEX for ztbmv

Array, size (lda, n).

Before entry with uplo = 'U' or 'u', the leading (k + 1) by n part of the array a must contain the upper triangular band part of the matrix of coefficients, supplied column-by-column, with the leading diagonal of the matrix in row (k + 1) of the array, the first super-diagonal starting at position 2 in row k, and so on. The top left k by k triangle of the array a is not referenced. The following program segment transfers an upper triangular band matrix from conventional full matrix storage (matrix) to band storage (a):

       do 20, j = 1, n
          m = k + 1 - j
          do 10, i = max( 1, j - k ), j
             a( m + i, j ) = matrix( i, j )
10        continue
20     continue

Before entry with uplo = 'L' or 'l', the leading (k + 1) by n part of the array a must contain the lower triangular band part of the matrix of coefficients, supplied column-by-column, with the leading diagonal of the matrix in row 1 of the array, the first sub-diagonal starting at position 1 in row 2, and so on. The bottom right k by k triangle of the array a is not referenced. The following program segment transfers a lower triangular band matrix from conventional full matrix storage (matrix) to band storage (a):

       do 20, j = 1, n
          m = 1 - j
          do 10, i = j, min( n, j + k )
             a( m + i, j ) = matrix( i, j )
10        continue
20     continue

Note that when uplo = 'U' or 'u', the elements of the array a corresponding to the diagonal elements of the matrix are not referenced, but are assumed to be unity.

lda

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

x

REAL for stbmv

DOUBLE PRECISION for dtbmv

COMPLEX for ctbmv

DOUBLE COMPLEX for ztbmv

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.

Output Parameters

x: Overwritten with the transformed vector x.

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 tbmv interface are the following:

a

Holds the array a of size (k+1,n).

x

Holds the vector with the number of elements n.

uplo

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

trans

Must be 'N', 'C', or 'T'.

The default value is 'N'.

diag

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

Parent topic: BLAS 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 Fortran

?tbmv