chbmv(3S)
CHBMV, ZHBMV - Multiplies a complex vector by a complex Hermitian band matrix
As shipped in IRIX 6.5.15. Added in IRIX 6.5.15.
NAME CHBMV, ZHBMV - Multiplies a complex vector by a complex Hermitian band matrix SYNOPSIS Single precision complex Fortran: CALL CHBMV (uplo, n, k, alpha, a, lda, x, incx, beta, y, incy) C/C++: #include <scsl_blas.h> void chbmv(char *uplo, int n, int k, scsl_complex *alpha, scsl_complex *a, int lda, scsl_complex *x, int incx, scsl_complex *beta, scsl_complex *y, int incy); C++ STL: #include <complex.h> #include <scsl_blas.h> void chbmv(char *uplo, int n, int k, complex<float> *alpha, complex<float> *a, int lda, complex<float> *x, int incx, complex<float> *beta, complex<float> *y, int incy); Double precision complex Fortran: CALL ZHBMV (uplo, n, k, alpha, a, lda, x, incx, beta, y, incy) C/C++: #include <scsl_blas.h> void zhbmv(char *uplo, int n, int k, scsl_zomplex *alpha, scsl_zomplex *a, int lda, scsl_zomplex *x, int incx, scsl_zomplex *beta, scsl_zomplex *y, int incy); C++ STL: #include <scsl_blas.h> void zhbmv(char *uplo, int n, int k, complex<double> *alpha, complex<double> *a, int lda, complex<double> *x, int incx, complex<double> *beta, complex<double> *y, int incy); IMPLEMENTATION These routines are part of the SCSL Scientific Library and can be loaded using either the -lscs or the -lscs_mp option. The -lscs_mp option directs the linker to use the multi-processor version of the library. When linking to SCSL with -lscs or -lscs_mp, the default integer size is 4 bytes (32 bits). Another version of SCSL is available in which integers are 8 bytes (64 bits). This version allows the user access to larger memory sizes and helps when porting legacy Cray codes. It can be loaded by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use only one of the two versions; 4-byte integer and 8-byte integer library calls cannot be mixed. The C and C++ prototypes shown above are appropriate for the 4-byte integer version of SCSL. When using the 8-byte integer version, the variables of type int become long long and the <scsl_blas_i8.h> header file should be included. DESCRIPTION These routines perform the following operation: y <- alpha Ax + beta y where alpha and beta are scalars, x and y are n-element vectors, and A is an n-by-n Hermitian band matrix. See the NOTES section of this man page for information about the interpretation of the data types described in the following arguments. These routines have the following arguments: uplo Character. (input) Specifies whether the upper or lower triangular part of the band matrix A is supplied, as follows: uplo= 'U' or 'u': the upper triangular part of A is being supplied. uplo= 'L' or 'l': the lower triangular part of A is being supplied. For C/C++, a pointer to this character is passed. n Integer. (input) Specifies the order of matrix A. n >= 0. k Integer. (input) Specifies the number of superdiagonals of matrix A. k >= 0. alpha Scalar alpha. (input) CHBMV: Single precision complex. ZHBMV: Double precision complex. For C/C++, a pointer to this scalar is passed. a Array of dimension (lda,n). (input) CHBMV: Single precision complex array. ZHBMV: Double precision complex array. Before entry with uplo = 'U' or 'u, the leading (k+1)-by-n part of array a must contain the upper triangular band part of the Hermitian matrix, supplied column-by-column, with the leading diagonal of the matrix in row k+1 of the array, the first superdiagonal starting at position 2 in row k, and so on. The top left k-by-k triangle of array a is not referenced. Before entry with uplo = 'L' or 'l', the leading (k+1)-by-n part of array a must contain the lower triangular band part of the Hermitian matrix, supplied column-by-column, with the leading diagonal of the matrix in row 1 of the array, the first subdiagonal starting at position 1 in row 2, and so on. The bottom right k-by-k triangle of array a is not referenced. The imaginary parts of the diagonal elements need not be set and are assumed to be 0. See the NOTES section for examples of Fortran code that transfer a band matrix from conventional full matrix storage to band storage. lda Integer. (input) Specifies the first dimension of a as declared in the calling program. lda >= (k+1). x Array of dimension 1+(n-1) * |incx|. (input) CHBMV: Single precision complex array. ZHBMV: Double precision complex array. Contains vector x. incx Integer. (input) Specifies the increment for the elements of x. incx must not be 0. beta Scalar beta. (input) CHBMV: Single precision complex. ZHBMV: Double precision complex. For C/C++, a pointer to this scalar is passed. y Array of dimension 1+(n-1) * |incy|. (input and output) CHBMV: Single precision complex array. ZHBMV: Double precision complex array. Contains vector y. On exit, the updated vector overwrites array y. incy Integer. (input) Specifies the increment for the elements of y. incy must not be 0. NOTES The following program segment transfers the upper triangular part of a Hermitian band matrix from conventional full matrix storage to band storage: 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 The following program segment transfers the lower triangular part of a Hermitian band matrix from conventional full matrix storage to band storage: 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 These routines are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS). When working backward (incx < 0 or incy < 0), this routine starts at the end of the vector and moves backward, as follows: x(1-incx * (n-1)), x(1-incx * (n-2)) , ..., x(1) y(1-incy * (n-1)), y(1-incy * (n-2)) , ..., y(1) Data Types The following data types are described in this documentation: Term Used Data type Fortran: Array dimensioned n x(n) Array of dimensions (m,n) x(m,n) Character CHARACTER Integer INTEGER (INTEGER*8 for -lscs_i8[_mp]) Single precision complex COMPLEX Double precision complex DOUBLE COMPLEX C/C++: Array dimensioned n x[n] Array of dimensions (m,n) x[m*n] Character char Integer int (long long for -lscs_i8[_mp]) Single precision complex scsl_complex Double precision complex scsl_zomplex C++ STL: Array dimensioned n x[n] Array of dimensions (m,n) x[m*n] Character char Integer int (long long for -lscs_i8[_mp]) Single precision complex complex<float> Double precision complex complex<double> Note that you can explicitly declare multidimensional C/C++ arrays provided that the array dimensions are swapped with respect to the Fortran declaration (e.g., x[n][m] in C/C++ versus x(m,n) in Fortran). To avoid a compiler type mismatch error in C++ (or a compiler warning message in C), however, the array should be cast to a pointer of the appropriate type when passed as an argument to a SCSL routine. SEE ALSO INTRO_SCSL(3S), INTRO_BLAS2(3S), SSBMV(3S) INTRO_CBLAS(3S) for information about using the C interface to Fortran 77 Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic Linear Algebra Subprograms Technical Forum.