mirror of https://github.com/CNugteren/CLBlast.git synced 2024-07-07 12:23:46 +02:00

Cedric Nugteren a670c4c4bf All enums in the C API are now prefixed with CLBlast to avoid potential name clashes with other projects

2016-10-22 16:14:56 +02:00

162 KiB

Raw Blame History

CLBlast: API reference

xSWAP: Swap two vectors

Interchanges n elements of vectors x and y.

C++ API:

template <typename T>
StatusCode Swap(const size_t n,
                cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSswap(const size_t n,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDswap(const size_t n,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCswap(const size_t n,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZswap(const size_t n,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHswap(const size_t n,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to SWAP:

const size_t n: Integer size argument. This value must be positive.
cl_mem x_buffer: OpenCL buffer to store the output x vector.
const size_t x_offset: The offset in elements from the start of the output x vector.
const size_t x_inc: Stride/increment of the output x vector. This value must be greater than 0.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xSCAL: Vector scaling

Multiplies n elements of vector x by a scalar constant alpha.

C++ API:

template <typename T>
StatusCode Scal(const size_t n,
                const T alpha,
                cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSscal(const size_t n,
                               const float alpha,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDscal(const size_t n,
                               const double alpha,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCscal(const size_t n,
                               const cl_float2 alpha,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZscal(const size_t n,
                               const cl_double2 alpha,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHscal(const size_t n,
                               const cl_half alpha,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to SCAL:

const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
cl_mem x_buffer: OpenCL buffer to store the output x vector.
const size_t x_offset: The offset in elements from the start of the output x vector.
const size_t x_inc: Stride/increment of the output x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xCOPY: Vector copy

Copies the contents of vector x into vector y.

C++ API:

template <typename T>
StatusCode Copy(const size_t n,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastScopy(const size_t n,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDcopy(const size_t n,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCcopy(const size_t n,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZcopy(const size_t n,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHcopy(const size_t n,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to COPY:

const size_t n: Integer size argument. This value must be positive.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xAXPY: Vector-times-constant plus vector

Performs the operation y = alpha * x + y, in which x and y are vectors and alpha is a scalar constant.

C++ API:

template <typename T>
StatusCode Axpy(const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSaxpy(const size_t n,
                               const float alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDaxpy(const size_t n,
                               const double alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCaxpy(const size_t n,
                               const cl_float2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZaxpy(const size_t n,
                               const cl_double2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHaxpy(const size_t n,
                               const cl_half alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to AXPY:

const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xDOT: Dot product of two vectors

Multiplies n elements of the vectors x and y element-wise and accumulates the results. The sum is stored in the dot buffer.

C++ API:

template <typename T>
StatusCode Dot(const size_t n,
               cl_mem dot_buffer, const size_t dot_offset,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSdot(const size_t n,
                              cl_mem dot_buffer, const size_t dot_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDdot(const size_t n,
                              cl_mem dot_buffer, const size_t dot_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHdot(const size_t n,
                              cl_mem dot_buffer, const size_t dot_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_command_queue* queue, cl_event* event)

Arguments to DOT:

const size_t n: Integer size argument. This value must be positive.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xDOTU: Dot product of two complex vectors

See the regular xDOT routine.

C++ API:

template <typename T>
StatusCode Dotu(const size_t n,
                cl_mem dot_buffer, const size_t dot_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCdotu(const size_t n,
                               cl_mem dot_buffer, const size_t dot_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZdotu(const size_t n,
                               cl_mem dot_buffer, const size_t dot_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to DOTU:

const size_t n: Integer size argument. This value must be positive.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xDOTC: Dot product of two complex vectors, one conjugated

See the regular xDOT routine.

C++ API:

template <typename T>
StatusCode Dotc(const size_t n,
                cl_mem dot_buffer, const size_t dot_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCdotc(const size_t n,
                               cl_mem dot_buffer, const size_t dot_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZdotc(const size_t n,
                               cl_mem dot_buffer, const size_t dot_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to DOTC:

const size_t n: Integer size argument. This value must be positive.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
cl_mem dot_buffer: OpenCL buffer to store the output dot vector.
const size_t dot_offset: The offset in elements from the start of the output dot vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xNRM2: Euclidian norm of a vector

Accumulates the square of n elements in the x vector and takes the square root. The resulting L2 norm is stored in the nrm2 buffer.

C++ API:

template <typename T>
StatusCode Nrm2(const size_t n,
                cl_mem nrm2_buffer, const size_t nrm2_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSnrm2(const size_t n,
                               cl_mem nrm2_buffer, const size_t nrm2_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDnrm2(const size_t n,
                               cl_mem nrm2_buffer, const size_t nrm2_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastScnrm2(const size_t n,
                               cl_mem nrm2_buffer, const size_t nrm2_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDznrm2(const size_t n,
                               cl_mem nrm2_buffer, const size_t nrm2_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHnrm2(const size_t n,
                               cl_mem nrm2_buffer, const size_t nrm2_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to NRM2:

const size_t n: Integer size argument. This value must be positive.
cl_mem nrm2_buffer: OpenCL buffer to store the output nrm2 vector.
const size_t nrm2_offset: The offset in elements from the start of the output nrm2 vector.
cl_mem nrm2_buffer: OpenCL buffer to store the output nrm2 vector.
const size_t nrm2_offset: The offset in elements from the start of the output nrm2 vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xASUM: Absolute sum of values in a vector

Accumulates the absolute value of n elements in the x vector. The results are stored in the asum buffer.

C++ API:

template <typename T>
StatusCode Asum(const size_t n,
                cl_mem asum_buffer, const size_t asum_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSasum(const size_t n,
                               cl_mem asum_buffer, const size_t asum_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDasum(const size_t n,
                               cl_mem asum_buffer, const size_t asum_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastScasum(const size_t n,
                               cl_mem asum_buffer, const size_t asum_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDzasum(const size_t n,
                               cl_mem asum_buffer, const size_t asum_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHasum(const size_t n,
                               cl_mem asum_buffer, const size_t asum_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to ASUM:

const size_t n: Integer size argument. This value must be positive.
cl_mem asum_buffer: OpenCL buffer to store the output asum vector.
const size_t asum_offset: The offset in elements from the start of the output asum vector.
cl_mem asum_buffer: OpenCL buffer to store the output asum vector.
const size_t asum_offset: The offset in elements from the start of the output asum vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xSUM: Sum of values in a vector (non-BLAS function)

Accumulates the values of n elements in the x vector. The results are stored in the sum buffer. This routine is the non-absolute version of the xASUM BLAS routine.

C++ API:

template <typename T>
StatusCode Sum(const size_t n,
               cl_mem sum_buffer, const size_t sum_offset,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsum(const size_t n,
                              cl_mem sum_buffer, const size_t sum_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsum(const size_t n,
                              cl_mem sum_buffer, const size_t sum_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastScsum(const size_t n,
                              cl_mem sum_buffer, const size_t sum_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDzsum(const size_t n,
                              cl_mem sum_buffer, const size_t sum_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsum(const size_t n,
                              cl_mem sum_buffer, const size_t sum_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)

Arguments to SUM:

const size_t n: Integer size argument. This value must be positive.
cl_mem sum_buffer: OpenCL buffer to store the output sum vector.
const size_t sum_offset: The offset in elements from the start of the output sum vector.
cl_mem sum_buffer: OpenCL buffer to store the output sum vector.
const size_t sum_offset: The offset in elements from the start of the output sum vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xAMAX: Index of absolute maximum value in a vector

Finds the index of the maximum of the absolute values in the x vector. The resulting integer index is stored in the imax buffer.

C++ API:

template <typename T>
StatusCode Amax(const size_t n,
                cl_mem imax_buffer, const size_t imax_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastiSamax(const size_t n,
                               cl_mem imax_buffer, const size_t imax_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiDamax(const size_t n,
                               cl_mem imax_buffer, const size_t imax_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiCamax(const size_t n,
                               cl_mem imax_buffer, const size_t imax_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiZamax(const size_t n,
                               cl_mem imax_buffer, const size_t imax_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiHamax(const size_t n,
                               cl_mem imax_buffer, const size_t imax_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to AMAX:

const size_t n: Integer size argument. This value must be positive.
cl_mem imax_buffer: OpenCL buffer to store the output imax vector.
const size_t imax_offset: The offset in elements from the start of the output imax vector.
cl_mem imax_buffer: OpenCL buffer to store the output imax vector.
const size_t imax_offset: The offset in elements from the start of the output imax vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xMAX: Index of maximum value in a vector (non-BLAS function)

Finds the index of the maximum of the values in the x vector. The resulting integer index is stored in the imax buffer. This routine is the non-absolute version of the IxAMAX BLAS routine.

C++ API:

template <typename T>
StatusCode Max(const size_t n,
               cl_mem imax_buffer, const size_t imax_offset,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastiSmax(const size_t n,
                              cl_mem imax_buffer, const size_t imax_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiDmax(const size_t n,
                              cl_mem imax_buffer, const size_t imax_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiCmax(const size_t n,
                              cl_mem imax_buffer, const size_t imax_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiZmax(const size_t n,
                              cl_mem imax_buffer, const size_t imax_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiHmax(const size_t n,
                              cl_mem imax_buffer, const size_t imax_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)

Arguments to MAX:

const size_t n: Integer size argument. This value must be positive.
cl_mem imax_buffer: OpenCL buffer to store the output imax vector.
const size_t imax_offset: The offset in elements from the start of the output imax vector.
cl_mem imax_buffer: OpenCL buffer to store the output imax vector.
const size_t imax_offset: The offset in elements from the start of the output imax vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xMIN: Index of minimum value in a vector (non-BLAS function)

Finds the index of the minimum of the values in the x vector. The resulting integer index is stored in the imin buffer. This routine is the non-absolute minimum version of the IxAMAX BLAS routine.

C++ API:

template <typename T>
StatusCode Min(const size_t n,
               cl_mem imin_buffer, const size_t imin_offset,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastiSmin(const size_t n,
                              cl_mem imin_buffer, const size_t imin_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiDmin(const size_t n,
                              cl_mem imin_buffer, const size_t imin_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiCmin(const size_t n,
                              cl_mem imin_buffer, const size_t imin_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiZmin(const size_t n,
                              cl_mem imin_buffer, const size_t imin_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastiHmin(const size_t n,
                              cl_mem imin_buffer, const size_t imin_offset,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_command_queue* queue, cl_event* event)

Arguments to MIN:

const size_t n: Integer size argument. This value must be positive.
cl_mem imin_buffer: OpenCL buffer to store the output imin vector.
const size_t imin_offset: The offset in elements from the start of the output imin vector.
cl_mem imin_buffer: OpenCL buffer to store the output imin vector.
const size_t imin_offset: The offset in elements from the start of the output imin vector.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xGEMV: General matrix-vector multiplication

Performs the operation y = alpha * A * x + beta * y, in which x is an input vector, y is an input and output vector, A is an input matrix, and alpha and beta are scalars. The matrix A can optionally be transposed before performing the operation.

C++ API:

template <typename T>
StatusCode Gemv(const Layout layout, const Transpose a_transpose,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSgemv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const float beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDgemv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const double beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCgemv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_float2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZgemv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_double2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHgemv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_half beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to GEMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GEMV:

The value of a_ld must be at least m.

xGBMV: General banded matrix-vector multiplication

Same operation as xGEMV, but matrix A is banded instead.

C++ API:

template <typename T>
StatusCode Gbmv(const Layout layout, const Transpose a_transpose,
                const size_t m, const size_t n, const size_t kl, const size_t ku,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSgbmv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n, const size_t kl, const size_t ku,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const float beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDgbmv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n, const size_t kl, const size_t ku,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const double beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCgbmv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n, const size_t kl, const size_t ku,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_float2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZgbmv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n, const size_t kl, const size_t ku,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_double2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHgbmv(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                               const size_t m, const size_t n, const size_t kl, const size_t ku,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_half beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to GBMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const size_t kl: Integer size argument. This value must be positive.
const size_t ku: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GBMV:

The value of a_ld must be at least kl + ku + 1.

xHEMV: Hermitian matrix-vector multiplication

Same operation as xGEMV, but matrix A is an Hermitian matrix instead.

C++ API:

template <typename T>
StatusCode Hemv(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChemv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_float2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhemv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_double2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to HEMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HEMV:

The value of a_ld must be at least n.

xHBMV: Hermitian banded matrix-vector multiplication

Same operation as xGEMV, but matrix A is an Hermitian banded matrix instead.

C++ API:

template <typename T>
StatusCode Hbmv(const Layout layout, const Triangle triangle,
                const size_t n, const size_t k,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChbmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n, const size_t k,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_float2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhbmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n, const size_t k,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_double2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to HBMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HBMV:

The value of a_ld must be at least k + 1.

xHPMV: Hermitian packed matrix-vector multiplication

Same operation as xGEMV, but matrix A is an Hermitian packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Hpmv(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem ap_buffer, const size_t ap_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChpmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_float2 alpha,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_float2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhpmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_double2 alpha,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_double2 beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to HPMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem ap_buffer: OpenCL buffer to store the input AP matrix.
const size_t ap_offset: The offset in elements from the start of the input AP matrix.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xSYMV: Symmetric matrix-vector multiplication

Same operation as xGEMV, but matrix A is symmetric instead.

C++ API:

template <typename T>
StatusCode Symv(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsymv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const float beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsymv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const double beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsymv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_half beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to SYMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYMV:

The value of a_ld must be at least n.

xSBMV: Symmetric banded matrix-vector multiplication

Same operation as xGEMV, but matrix A is symmetric and banded instead.

C++ API:

template <typename T>
StatusCode Sbmv(const Layout layout, const Triangle triangle,
                const size_t n, const size_t k,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsbmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n, const size_t k,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const float beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsbmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n, const size_t k,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const double beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsbmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n, const size_t k,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_half beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to SBMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SBMV:

The value of a_ld must be at least k + 1.

xSPMV: Symmetric packed matrix-vector multiplication

Same operation as xGEMV, but matrix A is a symmetric packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Spmv(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem ap_buffer, const size_t ap_offset,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const T beta,
                cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSspmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const float alpha,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const float beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDspmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const double alpha,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const double beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHspmv(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_half alpha,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_half beta,
                               cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to SPMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem ap_buffer: OpenCL buffer to store the input AP matrix.
const size_t ap_offset: The offset in elements from the start of the input AP matrix.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem y_buffer: OpenCL buffer to store the output y vector.
const size_t y_offset: The offset in elements from the start of the output y vector.
const size_t y_inc: Stride/increment of the output y vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xTRMV: Triangular matrix-vector multiplication

Same operation as xGEMV, but matrix A is triangular instead.

C++ API:

template <typename T>
StatusCode Trmv(const Layout layout, const Triangle triangle, const Transpose a_transpose, const Diagonal diagonal,
                const size_t n,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastStrmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDtrmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCtrmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZtrmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHtrmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to TRMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const Diagonal diagonal: The property of the diagonal matrix, either Diagonal::kNonUnit (131) for non-unit values on the diagonal or Diagonal::kUnit (132) for unit values on the diagonal.
const size_t n: Integer size argument. This value must be positive.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
cl_mem x_buffer: OpenCL buffer to store the output x vector.
const size_t x_offset: The offset in elements from the start of the output x vector.
const size_t x_inc: Stride/increment of the output x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for TRMV:

The value of a_ld must be at least n.

xTBMV: Triangular banded matrix-vector multiplication

Same operation as xGEMV, but matrix A is triangular and banded instead.

C++ API:

template <typename T>
StatusCode Tbmv(const Layout layout, const Triangle triangle, const Transpose a_transpose, const Diagonal diagonal,
                const size_t n, const size_t k,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastStbmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n, const size_t k,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDtbmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n, const size_t k,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCtbmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n, const size_t k,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZtbmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n, const size_t k,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHtbmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n, const size_t k,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to TBMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const Diagonal diagonal: The property of the diagonal matrix, either Diagonal::kNonUnit (131) for non-unit values on the diagonal or Diagonal::kUnit (132) for unit values on the diagonal.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
cl_mem x_buffer: OpenCL buffer to store the output x vector.
const size_t x_offset: The offset in elements from the start of the output x vector.
const size_t x_inc: Stride/increment of the output x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for TBMV:

The value of a_ld must be at least k + 1.

xTPMV: Triangular packed matrix-vector multiplication

Same operation as xGEMV, but matrix A is a triangular packed matrix instead and repreented as AP.

C++ API:

template <typename T>
StatusCode Tpmv(const Layout layout, const Triangle triangle, const Transpose a_transpose, const Diagonal diagonal,
                const size_t n,
                const cl_mem ap_buffer, const size_t ap_offset,
                cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastStpmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDtpmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCtpmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZtpmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHtpmv(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t n,
                               const cl_mem ap_buffer, const size_t ap_offset,
                               cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               cl_command_queue* queue, cl_event* event)

Arguments to TPMV:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const Diagonal diagonal: The property of the diagonal matrix, either Diagonal::kNonUnit (131) for non-unit values on the diagonal or Diagonal::kUnit (132) for unit values on the diagonal.
const size_t n: Integer size argument. This value must be positive.
const cl_mem ap_buffer: OpenCL buffer to store the input AP matrix.
const size_t ap_offset: The offset in elements from the start of the input AP matrix.
cl_mem x_buffer: OpenCL buffer to store the output x vector.
const size_t x_offset: The offset in elements from the start of the output x vector.
const size_t x_inc: Stride/increment of the output x vector. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xGER: General rank-1 matrix update

Performs the operation A = alpha * x * y^T + A, in which x is an input vector, y^T is the transpose of the input vector y, A is the matrix to be updated, and alpha is a scalar value.

C++ API:

template <typename T>
StatusCode Ger(const Layout layout,
               const size_t m, const size_t n,
               const T alpha,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSger(const CLBlastLayout layout,
                              const size_t m, const size_t n,
                              const float alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDger(const CLBlastLayout layout,
                              const size_t m, const size_t n,
                              const double alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHger(const CLBlastLayout layout,
                              const size_t m, const size_t n,
                              const cl_half alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)

Arguments to GER:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GER:

The value of a_ld must be at least m.

xGERU: General rank-1 complex matrix update

Same operation as xGER, but with complex data-types.

C++ API:

template <typename T>
StatusCode Geru(const Layout layout,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCgeru(const CLBlastLayout layout,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZgeru(const CLBlastLayout layout,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to GERU:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GERU:

The value of a_ld must be at least m.

xGERC: General rank-1 complex conjugated matrix update

Same operation as xGERU, but the update is done based on the complex conjugate of the input vectors.

C++ API:

template <typename T>
StatusCode Gerc(const Layout layout,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCgerc(const CLBlastLayout layout,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZgerc(const CLBlastLayout layout,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to GERC:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GERC:

The value of a_ld must be at least m.

xHER: Hermitian rank-1 matrix update

Performs the operation A = alpha * x * x^T + A, in which x is an input vector, x^T is the transpose of this vector, A is the triangular Hermetian matrix to be updated, and alpha is a scalar value.

C++ API:

template <typename T>
StatusCode Her(const Layout layout, const Triangle triangle,
               const size_t n,
               const T alpha,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCher(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const float alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZher(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const double alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)

Arguments to HER:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HER:

The value of a_ld must be at least n.

xHPR: Hermitian packed rank-1 matrix update

Same operation as xHER, but matrix A is an Hermitian packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Hpr(const Layout layout, const Triangle triangle,
               const size_t n,
               const T alpha,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_mem ap_buffer, const size_t ap_offset,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChpr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const float alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem ap_buffer, const size_t ap_offset,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhpr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const double alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem ap_buffer, const size_t ap_offset,
                              cl_command_queue* queue, cl_event* event)

Arguments to HPR:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem ap_buffer: OpenCL buffer to store the output AP matrix.
const size_t ap_offset: The offset in elements from the start of the output AP matrix.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xHER2: Hermitian rank-2 matrix update

Performs the operation A = alpha * x * y^T + conj(alpha) * y * x^T + A, in which x is an input vector and x^T its transpose, y is an input vector and y^T its transpose, A is the triangular Hermetian matrix to be updated, alpha is a scalar value and conj(alpha) its complex conjugate.

C++ API:

template <typename T>
StatusCode Her2(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCher2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_float2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZher2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_double2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to HER2:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HER2:

The value of a_ld must be at least n.

xHPR2: Hermitian packed rank-2 matrix update

Same operation as xHER2, but matrix A is an Hermitian packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Hpr2(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem ap_buffer, const size_t ap_offset,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChpr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_float2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem ap_buffer, const size_t ap_offset,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhpr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_double2 alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem ap_buffer, const size_t ap_offset,
                               cl_command_queue* queue, cl_event* event)

Arguments to HPR2:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem ap_buffer: OpenCL buffer to store the output AP matrix.
const size_t ap_offset: The offset in elements from the start of the output AP matrix.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xSYR: Symmetric rank-1 matrix update

Same operation as xHER, but matrix A is a symmetric matrix instead.

C++ API:

template <typename T>
StatusCode Syr(const Layout layout, const Triangle triangle,
               const size_t n,
               const T alpha,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsyr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const float alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsyr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const double alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsyr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const cl_half alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                              cl_command_queue* queue, cl_event* event)

Arguments to SYR:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYR:

The value of a_ld must be at least n.

xSPR: Symmetric packed rank-1 matrix update

Same operation as xSPR, but matrix A is a symmetric packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Spr(const Layout layout, const Triangle triangle,
               const size_t n,
               const T alpha,
               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
               cl_mem ap_buffer, const size_t ap_offset,
               cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSspr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const float alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem ap_buffer, const size_t ap_offset,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDspr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const double alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem ap_buffer, const size_t ap_offset,
                              cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHspr(const CLBlastLayout layout, const CLBlastTriangle triangle,
                              const size_t n,
                              const cl_half alpha,
                              const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                              cl_mem ap_buffer, const size_t ap_offset,
                              cl_command_queue* queue, cl_event* event)

Arguments to SPR:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
cl_mem ap_buffer: OpenCL buffer to store the output AP matrix.
const size_t ap_offset: The offset in elements from the start of the output AP matrix.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xSYR2: Symmetric rank-2 matrix update

Same operation as xHER2, but matrix A is a symmetric matrix instead.

C++ API:

template <typename T>
StatusCode Syr2(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsyr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const float alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsyr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const double alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsyr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_half alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to SYR2:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem a_buffer: OpenCL buffer to store the output A matrix.
const size_t a_offset: The offset in elements from the start of the output A matrix.
const size_t a_ld: Leading dimension of the output A matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYR2:

The value of a_ld must be at least n.

xSPR2: Symmetric packed rank-2 matrix update

Same operation as xSPR2, but matrix A is a symmetric packed matrix instead and represented as AP.

C++ API:

template <typename T>
StatusCode Spr2(const Layout layout, const Triangle triangle,
                const size_t n,
                const T alpha,
                const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                cl_mem ap_buffer, const size_t ap_offset,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSspr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const float alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem ap_buffer, const size_t ap_offset,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDspr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const double alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem ap_buffer, const size_t ap_offset,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHspr2(const CLBlastLayout layout, const CLBlastTriangle triangle,
                               const size_t n,
                               const cl_half alpha,
                               const cl_mem x_buffer, const size_t x_offset, const size_t x_inc,
                               const cl_mem y_buffer, const size_t y_offset, const size_t y_inc,
                               cl_mem ap_buffer, const size_t ap_offset,
                               cl_command_queue* queue, cl_event* event)

Arguments to SPR2:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem x_buffer: OpenCL buffer to store the input x vector.
const size_t x_offset: The offset in elements from the start of the input x vector.
const size_t x_inc: Stride/increment of the input x vector. This value must be greater than 0.
const cl_mem y_buffer: OpenCL buffer to store the input y vector.
const size_t y_offset: The offset in elements from the start of the input y vector.
const size_t y_inc: Stride/increment of the input y vector. This value must be greater than 0.
cl_mem ap_buffer: OpenCL buffer to store the output AP matrix.
const size_t ap_offset: The offset in elements from the start of the output AP matrix.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

xGEMM: General matrix-matrix multiplication

Performs the matrix product C = alpha * A * B + beta * C, in which A (m by k) and B (k by n) are two general rectangular input matrices, C (m by n) is the matrix to be updated, and alpha and beta are scalar values. The matrices A and/or B can optionally be transposed before performing the operation.

C++ API:

template <typename T>
StatusCode Gemm(const Layout layout, const Transpose a_transpose, const Transpose b_transpose,
                const size_t m, const size_t n, const size_t k,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                const T beta,
                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSgemm(const CLBlastLayout layout, const CLBlastTranspose a_transpose, const CLBlastTranspose b_transpose,
                               const size_t m, const size_t n, const size_t k,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const float beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDgemm(const CLBlastLayout layout, const CLBlastTranspose a_transpose, const CLBlastTranspose b_transpose,
                               const size_t m, const size_t n, const size_t k,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const double beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCgemm(const CLBlastLayout layout, const CLBlastTranspose a_transpose, const CLBlastTranspose b_transpose,
                               const size_t m, const size_t n, const size_t k,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_float2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZgemm(const CLBlastLayout layout, const CLBlastTranspose a_transpose, const CLBlastTranspose b_transpose,
                               const size_t m, const size_t n, const size_t k,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_double2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHgemm(const CLBlastLayout layout, const CLBlastTranspose a_transpose, const CLBlastTranspose b_transpose,
                               const size_t m, const size_t n, const size_t k,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_half beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to GEMM:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const Transpose b_transpose: Transposing the input matrix B, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem b_buffer: OpenCL buffer to store the input B matrix.
const size_t b_offset: The offset in elements from the start of the input B matrix.
const size_t b_ld: Leading dimension of the input B matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for GEMM:

When transpose_a == Transpose::kNo, then a_ld must be at least m, otherwise a_ld must be at least k.
When transpose_b == Transpose::kNo, then b_ld must be at least k, otherwise b_ld must be at least n.
The value of c_ld must be at least m.

xSYMM: Symmetric matrix-matrix multiplication

Same operation as xGEMM, but A is symmetric instead. In case of side == kLeft, A is a symmetric m by m matrix and C = alpha * A * B + beta * C is performed. Otherwise, in case of side == kRight, A is a symmtric n by n matrix and C = alpha * B * A + beta * C is performed.

C++ API:

template <typename T>
StatusCode Symm(const Layout layout, const Side side, const Triangle triangle,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                const T beta,
                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsymm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const float beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsymm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const double beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCsymm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_float2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZsymm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_double2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsymm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_half beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to SYMM:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Side side: The position of the triangular matrix in the operation, either on the Side::kLeft (141) or Side::kRight (142).
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem b_buffer: OpenCL buffer to store the input B matrix.
const size_t b_offset: The offset in elements from the start of the input B matrix.
const size_t b_ld: Leading dimension of the input B matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYMM:

When side = Side::kLeft then a_ld must be at least m, otherwise a_ld must be at least n.
The value of b_ld must be at least m.
The value of c_ld must be at least m.

xHEMM: Hermitian matrix-matrix multiplication

Same operation as xSYMM, but A is an Hermitian matrix instead.

C++ API:

template <typename T>
StatusCode Hemm(const Layout layout, const Side side, const Triangle triangle,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                const T beta,
                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastChemm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_float2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZhemm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               const cl_double2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to HEMM:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Side side: The position of the triangular matrix in the operation, either on the Side::kLeft (141) or Side::kRight (142).
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem b_buffer: OpenCL buffer to store the input B matrix.
const size_t b_offset: The offset in elements from the start of the input B matrix.
const size_t b_ld: Leading dimension of the input B matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HEMM:

When side = Side::kLeft then a_ld must be at least m, otherwise a_ld must be at least n.
The value of b_ld must be at least m.
The value of c_ld must be at least m.

xSYRK: Rank-K update of a symmetric matrix

Performs the matrix product C = alpha * A * A^T + beta * C or C = alpha * A^T * A + beta * C, in which A is a general matrix and A^T is its transpose, C (n by n) is the symmetric matrix to be updated, and alpha and beta are scalar values.

C++ API:

template <typename T>
StatusCode Syrk(const Layout layout, const Triangle triangle, const Transpose a_transpose,
                const size_t n, const size_t k,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const T beta,
                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsyrk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const float beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsyrk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const double beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCsyrk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_float2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZsyrk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_double2 beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsyrk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const cl_half beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to SYRK:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYRK:

When transpose == Transpose::kNo, then a_ld must be at least n, otherwise a_ld must be at least k.
The value of c_ld must be at least m.

xHERK: Rank-K update of a hermitian matrix

Same operation as xSYRK, but C is an Hermitian matrix instead.

C++ API:

template <typename T>
StatusCode Herk(const Layout layout, const Triangle triangle, const Transpose a_transpose,
                const size_t n, const size_t k,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                const T beta,
                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCherk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const float beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZherk(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose,
                               const size_t n, const size_t k,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               const double beta,
                               cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to HERK:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HERK:

When transpose == Transpose::kNo, then a_ld must be at least n, otherwise a_ld must be at least k.
The value of c_ld must be at least m.

xSYR2K: Rank-2K update of a symmetric matrix

Performs the matrix product C = alpha * A * B^T + alpha * B * A^T + beta * C or C = alpha * A^T * B + alpha * B^T * A + beta * C, in which A and B are general matrices and A^T and B^T are their transposed versions, C (n by n) is the symmetric matrix to be updated, and alpha and beta are scalar values.

C++ API:

template <typename T>
StatusCode Syr2k(const Layout layout, const Triangle triangle, const Transpose ab_transpose,
                 const size_t n, const size_t k,
                 const T alpha,
                 const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                 const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                 const T beta,
                 cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                 cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSsyr2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const float alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const float beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDsyr2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const double alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const double beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCsyr2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const cl_float2 alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const cl_float2 beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZsyr2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const cl_double2 alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const cl_double2 beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHsyr2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const cl_half alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const cl_half beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)

Arguments to SYR2K:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose ab_transpose: Transposing the packed input matrix AP, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem b_buffer: OpenCL buffer to store the input B matrix.
const size_t b_offset: The offset in elements from the start of the input B matrix.
const size_t b_ld: Leading dimension of the input B matrix. This value must be greater than 0.
const T beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for SYR2K:

When transpose == Transpose::kNo, then a_ld must be at least n, otherwise a_ld must be at least k.
When transpose == Transpose::kNo, then b_ld must be at least n, otherwise b_ld must be at least k.
The value of c_ld must be at least n.

xHER2K: Rank-2K update of a hermitian matrix

Same operation as xSYR2K, but C is an Hermitian matrix instead.

C++ API:

template <typename T, typename U>
StatusCode Her2k(const Layout layout, const Triangle triangle, const Transpose ab_transpose,
                 const size_t n, const size_t k,
                 const T alpha,
                 const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                 const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                 const U beta,
                 cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                 cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastCher2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const cl_float2 alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const float beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZher2k(const CLBlastLayout layout, const CLBlastTriangle triangle, const CLBlastTranspose ab_transpose,
                                const size_t n, const size_t k,
                                const cl_double2 alpha,
                                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                const cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                const double beta,
                                cl_mem c_buffer, const size_t c_offset, const size_t c_ld,
                                cl_command_queue* queue, cl_event* event)

Arguments to HER2K:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose ab_transpose: Transposing the packed input matrix AP, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t n: Integer size argument. This value must be positive.
const size_t k: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
const cl_mem b_buffer: OpenCL buffer to store the input B matrix.
const size_t b_offset: The offset in elements from the start of the input B matrix.
const size_t b_ld: Leading dimension of the input B matrix. This value must be greater than 0.
const U beta: Input scalar constant.
cl_mem c_buffer: OpenCL buffer to store the output C matrix.
const size_t c_offset: The offset in elements from the start of the output C matrix.
const size_t c_ld: Leading dimension of the output C matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for HER2K:

When transpose == Transpose::kNo, then a_ld must be at least n, otherwise a_ld must be at least k.
When transpose == Transpose::kNo, then b_ld must be at least n, otherwise b_ld must be at least k.
The value of c_ld must be at least n.

xTRMM: Triangular matrix-matrix multiplication

Performs the matrix product B = alpha * A * B or B = alpha * B * A, in which A is a unit or non-unit triangular matrix, B (m by n) is the general matrix to be updated, and alpha is a scalar value.

C++ API:

template <typename T>
StatusCode Trmm(const Layout layout, const Side side, const Triangle triangle, const Transpose a_transpose, const Diagonal diagonal,
                const size_t m, const size_t n,
                const T alpha,
                const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastStrmm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t m, const size_t n,
                               const float alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDtrmm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t m, const size_t n,
                               const double alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastCtrmm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t m, const size_t n,
                               const cl_float2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZtrmm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t m, const size_t n,
                               const cl_double2 alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHtrmm(const CLBlastLayout layout, const CLBlastSide side, const CLBlastTriangle triangle, const CLBlastTranspose a_transpose, const CLBlastDiagonal diagonal,
                               const size_t m, const size_t n,
                               const cl_half alpha,
                               const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                               cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                               cl_command_queue* queue, cl_event* event)

Arguments to TRMM:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Side side: The position of the triangular matrix in the operation, either on the Side::kLeft (141) or Side::kRight (142).
const Triangle triangle: The part of the array of the triangular matrix to be used, either Triangle::kUpper (121) or Triangle::kLower (122).
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const Diagonal diagonal: The property of the diagonal matrix, either Diagonal::kNonUnit (131) for non-unit values on the diagonal or Diagonal::kUnit (132) for unit values on the diagonal.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
cl_mem b_buffer: OpenCL buffer to store the output B matrix.
const size_t b_offset: The offset in elements from the start of the output B matrix.
const size_t b_ld: Leading dimension of the output B matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for TRMM:

When side = Side::kLeft then a_ld must be at least m, otherwise a_ld must be at least n.
The value of b_ld must be at least m.

xOMATCOPY: Scaling and out-place transpose/copy (non-BLAS function)

Performs scaling and out-of-place transposition/copying of matrices according to B = alpha*op(A), in which A is an input matrix (m rows by n columns), B an output matrix, and alpha a scalar value. The operation op can be a normal matrix copy, a transposition or a conjugate transposition.

C++ API:

template <typename T>
StatusCode Omatcopy(const Layout layout, const Transpose a_transpose,
                    const size_t m, const size_t n,
                    const T alpha,
                    const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                    cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                    cl_command_queue* queue, cl_event* event)

C API:

CLBlastStatusCode CLBlastSomatcopy(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                                   const size_t m, const size_t n,
                                   const float alpha,
                                   const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                   cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                   cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastDomatcopy(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                                   const size_t m, const size_t n,
                                   const double alpha,
                                   const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                   cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                   cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastComatcopy(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                                   const size_t m, const size_t n,
                                   const cl_float2 alpha,
                                   const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                   cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                   cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastZomatcopy(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                                   const size_t m, const size_t n,
                                   const cl_double2 alpha,
                                   const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                   cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                   cl_command_queue* queue, cl_event* event)
CLBlastStatusCode CLBlastHomatcopy(const CLBlastLayout layout, const CLBlastTranspose a_transpose,
                                   const size_t m, const size_t n,
                                   const cl_half alpha,
                                   const cl_mem a_buffer, const size_t a_offset, const size_t a_ld,
                                   cl_mem b_buffer, const size_t b_offset, const size_t b_ld,
                                   cl_command_queue* queue, cl_event* event)

Arguments to OMATCOPY:

const Layout layout: Data-layout of the matrices, either Layout::kRowMajor (101) for row-major layout or Layout::kColMajor (102) for column-major data-layout.
const Transpose a_transpose: Transposing the input matrix A, either Transpose::kNo (111), Transpose::kYes (112), or Transpose::kConjugate (113) for a complex-conjugate transpose.
const size_t m: Integer size argument. This value must be positive.
const size_t n: Integer size argument. This value must be positive.
const T alpha: Input scalar constant.
const cl_mem a_buffer: OpenCL buffer to store the input A matrix.
const size_t a_offset: The offset in elements from the start of the input A matrix.
const size_t a_ld: Leading dimension of the input A matrix. This value must be greater than 0.
cl_mem b_buffer: OpenCL buffer to store the output B matrix.
const size_t b_offset: The offset in elements from the start of the output B matrix.
const size_t b_ld: Leading dimension of the output B matrix. This value must be greater than 0.
cl_command_queue* queue: Pointer to an OpenCL command queue associated with a context and device to execute the routine on.
cl_event* event: Pointer to an OpenCL event to be able to wait for completion of the routine's OpenCL kernel(s). This is an optional argument.

Requirements for OMATCOPY:

The value of a_ld must be at least m.
The value of b_ld must be at least n.

162 KiB Raw Blame History

CLBlast: API reference

xSWAP: Swap two vectors

xSCAL: Vector scaling

xCOPY: Vector copy

xAXPY: Vector-times-constant plus vector

xDOT: Dot product of two vectors

xDOTU: Dot product of two complex vectors

xDOTC: Dot product of two complex vectors, one conjugated

xNRM2: Euclidian norm of a vector

xASUM: Absolute sum of values in a vector

xSUM: Sum of values in a vector (non-BLAS function)

xAMAX: Index of absolute maximum value in a vector

xMAX: Index of maximum value in a vector (non-BLAS function)

xMIN: Index of minimum value in a vector (non-BLAS function)

xGEMV: General matrix-vector multiplication

xGBMV: General banded matrix-vector multiplication

xHEMV: Hermitian matrix-vector multiplication

xHBMV: Hermitian banded matrix-vector multiplication

xHPMV: Hermitian packed matrix-vector multiplication

xSYMV: Symmetric matrix-vector multiplication

xSBMV: Symmetric banded matrix-vector multiplication

xSPMV: Symmetric packed matrix-vector multiplication

xTRMV: Triangular matrix-vector multiplication

xTBMV: Triangular banded matrix-vector multiplication

xTPMV: Triangular packed matrix-vector multiplication

xGER: General rank-1 matrix update

xGERU: General rank-1 complex matrix update

xGERC: General rank-1 complex conjugated matrix update

xHER: Hermitian rank-1 matrix update

xHPR: Hermitian packed rank-1 matrix update

xHER2: Hermitian rank-2 matrix update

xHPR2: Hermitian packed rank-2 matrix update

xSYR: Symmetric rank-1 matrix update

xSPR: Symmetric packed rank-1 matrix update

xSYR2: Symmetric rank-2 matrix update

xSPR2: Symmetric packed rank-2 matrix update

xGEMM: General matrix-matrix multiplication

xSYMM: Symmetric matrix-matrix multiplication

xHEMM: Hermitian matrix-matrix multiplication

xSYRK: Rank-K update of a symmetric matrix

xHERK: Rank-K update of a hermitian matrix

xSYR2K: Rank-2K update of a symmetric matrix

xHER2K: Rank-2K update of a hermitian matrix

xTRMM: Triangular matrix-matrix multiplication

xOMATCOPY: Scaling and out-place transpose/copy (non-BLAS function)

162 KiB

Raw Blame History