clBLAS 2.0
Loading...
Searching...
No Matches
TBMV - Triangular banded matrix vector multiply

Functions

clblasStatus clblasStbmv (clblasOrder order, clblasUplo uplo, clblasTranspose trans, clblasDiag diag, size_t N, size_t K, const cl_mem A, size_t offa, size_t lda, cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Matrix-vector product with a triangular banded matrix and float elements.
 
clblasStatus clblasDtbmv (clblasOrder order, clblasUplo uplo, clblasTranspose trans, clblasDiag diag, size_t N, size_t K, const cl_mem A, size_t offa, size_t lda, cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Matrix-vector product with a triangular banded matrix and double elements.
 
clblasStatus clblasCtbmv (clblasOrder order, clblasUplo uplo, clblasTranspose trans, clblasDiag diag, size_t N, size_t K, const cl_mem A, size_t offa, size_t lda, cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Matrix-vector product with a triangular banded matrix and float-complex elements.
 
clblasStatus clblasZtbmv (clblasOrder order, clblasUplo uplo, clblasTranspose trans, clblasDiag diag, size_t N, size_t K, const cl_mem A, size_t offa, size_t lda, cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Matrix-vector product with a triangular banded matrix and double-complex elements.
 

Detailed Description

Function Documentation

◆ clblasCtbmv()

clblasStatus clblasCtbmv ( clblasOrder order,
clblasUplo uplo,
clblasTranspose trans,
clblasDiag diag,
size_t N,
size_t K,
const cl_mem A,
size_t offa,
size_t lda,
cl_mem X,
size_t offx,
int incx,
cl_mem scratchBuff,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

Matrix-vector product with a triangular banded matrix and float-complex elements.

Matrix-vector products:

  • \( X \leftarrow A X \)
  • \( X \leftarrow A^T X \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]transHow matrix A is to be transposed.
[in]diagSpecify whether matrix A is unit triangular.
[in]NNumber of rows/columns in banded matrix A.
[in]KNumber of sub-diagonals/super-diagonals in triangular banded matrix A.
[in]ABuffer object storing matrix A.
[in]offaOffset in number of elements for first element in matrix A.
[in]ldaLeading dimension of matrix A. It cannot be less than ( K + 1 )
[out]XBuffer object storing vector X.
[in]offxOffset in number of elements for first element in vector X.
[in]incxIncrement for the elements of X. Must not be zero.
[in]scratchBuffTemporary cl_mem scratch buffer object which can hold a minimum of (1 + (N-1)*abs(incx)) elements
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent objects per each command queue that identify a particular kernel execution instance.
Returns
The same result as the clblasStbmv() function.

◆ clblasDtbmv()

clblasStatus clblasDtbmv ( clblasOrder order,
clblasUplo uplo,
clblasTranspose trans,
clblasDiag diag,
size_t N,
size_t K,
const cl_mem A,
size_t offa,
size_t lda,
cl_mem X,
size_t offx,
int incx,
cl_mem scratchBuff,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

Matrix-vector product with a triangular banded matrix and double elements.

Matrix-vector products:

  • \( X \leftarrow A X \)
  • \( X \leftarrow A^T X \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]transHow matrix A is to be transposed.
[in]diagSpecify whether matrix A is unit triangular.
[in]NNumber of rows/columns in banded matrix A.
[in]KNumber of sub-diagonals/super-diagonals in triangular banded matrix A.
[in]ABuffer object storing matrix A.
[in]offaOffset in number of elements for first element in matrix A.
[in]ldaLeading dimension of matrix A. It cannot be less than ( K + 1 )
[out]XBuffer object storing vector X.
[in]offxOffset in number of elements for first element in vector X.
[in]incxIncrement for the elements of X. Must not be zero.
[in]scratchBuffTemporary cl_mem scratch buffer object which can hold a minimum of (1 + (N-1)*abs(incx)) elements
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent objects per each command queue that identify a particular kernel execution instance.
Returns
  • clblasSuccess on success;
  • clblasInvalidDevice if a target device does not support floating point arithmetic with double precision;
  • the same error codes as the clblasStbmv() function otherwise.

◆ clblasStbmv()

clblasStatus clblasStbmv ( clblasOrder order,
clblasUplo uplo,
clblasTranspose trans,
clblasDiag diag,
size_t N,
size_t K,
const cl_mem A,
size_t offa,
size_t lda,
cl_mem X,
size_t offx,
int incx,
cl_mem scratchBuff,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

Matrix-vector product with a triangular banded matrix and float elements.

Matrix-vector products:

  • \( X \leftarrow A X \)
  • \( X \leftarrow A^T X \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]transHow matrix A is to be transposed.
[in]diagSpecify whether matrix A is unit triangular.
[in]NNumber of rows/columns in banded matrix A.
[in]KNumber of sub-diagonals/super-diagonals in triangular banded matrix A.
[in]ABuffer object storing matrix A.
[in]offaOffset in number of elements for first element in matrix A.
[in]ldaLeading dimension of matrix A. It cannot be less than ( K + 1 )
[out]XBuffer object storing vector X.
[in]offxOffset in number of elements for first element in vector X.
[in]incxIncrement for the elements of X. Must not be zero.
[in]scratchBuffTemporary cl_mem scratch buffer object which can hold a minimum of (1 + (N-1)*abs(incx)) elements
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent objects per each command queue that identify a particular kernel execution instance.
Returns
  • clblasSuccess on success;
  • clblasNotInitialized if clblasSetup() was not called;
  • clblasInvalidValue if invalid parameters are passed:
    • either N or incx is zero, or
    • K is greater than N - 1
    • the leading dimension is invalid;
  • clblasInvalidMemObject if either A or X object is Invalid, or an image object rather than the buffer one;
  • clblasOutOfHostMemory if the library can't allocate memory for internal structures;
  • clblasInvalidCommandQueue if the passed command queue is invalid;
  • clblasInvalidContext if a context a passed command queue belongs to was released;
  • clblasInvalidOperation if kernel compilation relating to a previous call has not completed for any of the target devices;
  • clblasCompilerNotAvailable if a compiler is not available;
  • clblasBuildProgramFailure if there is a failure to build a program executable.
Examples
example_stbmv.c.

◆ clblasZtbmv()

clblasStatus clblasZtbmv ( clblasOrder order,
clblasUplo uplo,
clblasTranspose trans,
clblasDiag diag,
size_t N,
size_t K,
const cl_mem A,
size_t offa,
size_t lda,
cl_mem X,
size_t offx,
int incx,
cl_mem scratchBuff,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

Matrix-vector product with a triangular banded matrix and double-complex elements.

Matrix-vector products:

  • \( X \leftarrow A X \)
  • \( X \leftarrow A^T X \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]transHow matrix A is to be transposed.
[in]diagSpecify whether matrix A is unit triangular.
[in]NNumber of rows/columns in banded matrix A.
[in]KNumber of sub-diagonals/super-diagonals in triangular banded matrix A.
[in]ABuffer object storing matrix A.
[in]offaOffset in number of elements for first element in matrix A.
[in]ldaLeading dimension of matrix A. It cannot be less than ( K + 1 )
[out]XBuffer object storing vector X.
[in]offxOffset in number of elements for first element in vector X.
[in]incxIncrement for the elements of X. Must not be zero.
[in]scratchBuffTemporary cl_mem scratch buffer object which can hold a minimum of (1 + (N-1)*abs(incx)) elements
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent objects per each command queue that identify a particular kernel execution instance.
Returns
The same result as the clblasDtbmv() function.