Developer Reference for Intel® oneAPI Math Kernel Library for Fortran
?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, mkl_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
- Layout
-
Specifies whether two-dimensional array storage is row-major ( CblasRowMajor ) or column-major ( CblasColMajor ).
uplo
CHARACTER*1 . Specifies whether the matrix A is an upper or lower triangular matrix:
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’ uplo = CblasUpper 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’ uplo = CblasUpper 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)lda*n .
Before entry with uplo = 'U' or ‘u’ uplo = CblasUpper , 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 ):
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 ):
Note that when uplo = 'U' or ‘u’ uplo = CblasUpper , the elements of the array a corresponding to the diagonal elements of the matrix are not referenced, but are assumed to be unity.
Layout = CblasRowMajor: Before entry with uplo = CblasUpper , the leading ( k + 1)-by- n part of array a must contain the upper triangular band part of the matrix of coefficients. The matrix must be supplied row-by-row, with the leading diagonal of the matrix in column 0 of the array, the first super-diagonal starting at position 0 in column 1, and so on. The bottom right k -by- k triangle of array a is not referenced. The following program segment transfers the upper triangular part of a Hermitian band matrix from row-major full matrix storage ( matrix with leading dimension ldm ) to row-major band storage ( a , with leading dimension lda ): Before entry with uplo = CblasLower , the leading ( k + 1)-by- n part of array a must contain the lower triangular band part of the matrix of coefficients, supplied row-by-row, with the leading diagonal of the matrix in column k of the array, the first sub-diagonal starting at position 1 in column k -1, and so on. The top left k -by- k triangle of array a is not referenced. The following program segment transfers the lower triangular part of a Hermitian row-major band matrix from row-major full matrix storage ( matrix , with leading dimension ldm ) to row-major band storage ( a , with leading dimension lda ):
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’ .