GEMV - General matrix-Vector multiplication

Functions
clblasStatus	clblasSgemv (clblasOrder order, clblasTranspose transA, size_t M, size_t N, cl_float alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem x, size_t offx, int incx, cl_float beta, cl_mem y, size_t offy, int incy, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Matrix-vector product with a general rectangular matrix and float elements. Extended version. More...
clblasStatus	clblasDgemv (clblasOrder order, clblasTranspose transA, size_t M, size_t N, cl_double alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem x, size_t offx, int incx, cl_double beta, cl_mem y, size_t offy, int incy, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Matrix-vector product with a general rectangular matrix and double elements. Extended version. More...
clblasStatus	clblasCgemv (clblasOrder order, clblasTranspose transA, size_t M, size_t N, FloatComplex alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem x, size_t offx, int incx, FloatComplex beta, cl_mem y, size_t offy, int incy, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Matrix-vector product with a general rectangular matrix and float complex elements. Extended version. More...
clblasStatus	clblasZgemv (clblasOrder order, clblasTranspose transA, size_t M, size_t N, DoubleComplex alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem x, size_t offx, int incx, DoubleComplex beta, cl_mem y, size_t offy, int incy, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Matrix-vector product with a general rectangular matrix and double complex elements. Extended version. More...

Detailed Description

Function Documentation

clblasStatus clblasCgemv	(	clblasOrder	order,
		clblasTranspose	transA,
		size_t	M,
		size_t	N,
		FloatComplex	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	x,
		size_t	offx,
		int	incx,
		FloatComplex	beta,
		cl_mem	y,
		size_t	offy,
		int	incy,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Matrix-vector product with a general rectangular matrix and float complex elements. Extended version.

Matrix-vector products:

• \( y \leftarrow \alpha A x + \beta y \)
• \( y \leftarrow \alpha A^T x + \beta y \)

Parameters

[in]	order	Row/column order.
[in]	transA	How matrix A is to be transposed.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	The factor of matrix A.
[in]	A	Buffer object storing matrix A.
[in]	offA	Offset of the first element of the matrix A in the buffer object. Counted in elements
[in]	lda	Leading dimension of matrix A. For a detailed description, see clblasSgemv().
[in]	x	Buffer object storing vector x.
[in]	offx	Offset of first element of vector x in buffer object. Counted in elements.
[in]	incx	Increment for the elements of x. It cannot be zero.
[in]	beta	The factor of the vector y.
[out]	y	Buffer object storing the vector y.
[in]	offy	Offset of first element of vector y in buffer object. Counted in elements.
[in]	incy	Increment for the elements of y. It cannot be zero.
[in]	numCommandQueues	Number of OpenCL command queues in which the task is to be performed.
[in]	commandQueues	OpenCL command queues.
[in]	numEventsInWaitList	Number of events in the event wait list.
[in]	eventWaitList	Event wait list.
[in]	events	Event objects per each command queue that identify a particular kernel execution instance.

Returns

• clblasSuccess on success;
• clblasInvalidValue if offA exceeds the size of A buffer object;
• the same error codes as the clblasSgemv() function otherwise.

clblasStatus clblasDgemv	(	clblasOrder	order,
		clblasTranspose	transA,
		size_t	M,
		size_t	N,
		cl_double	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	x,
		size_t	offx,
		int	incx,
		cl_double	beta,
		cl_mem	y,
		size_t	offy,
		int	incy,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Matrix-vector product with a general rectangular matrix and double elements. Extended version.

Matrix-vector products:

• \( y \leftarrow \alpha A x + \beta y \)
• \( y \leftarrow \alpha A^T x + \beta y \)

Parameters

[in]	order	Row/column order.
[in]	transA	How matrix A is to be transposed.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	The factor of matrix A.
[in]	A	Buffer object storing matrix A.
[in]	offA	Offset of the first element of A in the buffer object. Counted in elements.
[in]	lda	Leading dimension of matrix A. For a detailed description, see clblasSgemv().
[in]	x	Buffer object storing vector x.
[in]	offx	Offset of first element of vector x in buffer object. Counted in elements.
[in]	incx	Increment for the elements of x. It cannot be zero.
[in]	beta	The factor of the vector y.
[out]	y	Buffer object storing the vector y.
[in]	offy	Offset of first element of vector y in buffer object. Counted in elements.
[in]	incy	Increment for the elements of y. It cannot be zero.
[in]	numCommandQueues	Number of OpenCL command queues in which the task is to be performed.
[in]	commandQueues	OpenCL command queues.
[in]	numEventsInWaitList	Number of events in the event wait list.
[in]	eventWaitList	Event wait list.
[in]	events	Event objects per each command queue that identify a particular kernel execution instance.

Returns

• clblasSuccess on success;
• clblasInvalidDevice if a target device does not support the floating point arithmetic with double precision;
• clblasInvalidValue if offA exceeds the size of A buffer object;
• the same error codes as the clblasSgemv() function otherwise.

clblasStatus clblasSgemv	(	clblasOrder	order,
		clblasTranspose	transA,
		size_t	M,
		size_t	N,
		cl_float	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	x,
		size_t	offx,
		int	incx,
		cl_float	beta,
		cl_mem	y,
		size_t	offy,
		int	incy,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Matrix-vector product with a general rectangular matrix and float elements. Extended version.

Matrix-vector products:

• \( y \leftarrow \alpha A x + \beta y \)
• \( y \leftarrow \alpha A^T x + \beta y \)

Parameters

[in]	order	Row/column order.
[in]	transA	How matrix A is to be transposed.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	The factor of matrix A.
[in]	A	Buffer object storing matrix A.
[in]	offA	Offset of the first element of the matrix A in the buffer object. Counted in elements.
[in]	lda	Leading dimension of matrix A. It cannot be less than N when the order parameter is set to clblasRowMajor, or less than M when the parameter is set to clblasColumnMajor.
[in]	x	Buffer object storing vector x.
[in]	offx	Offset of first element of vector x in buffer object. Counted in elements.
[in]	incx	Increment for the elements of x. It cannot be zero.
[in]	beta	The factor of the vector y.
[out]	y	Buffer object storing the vector y.
[in]	offy	Offset of first element of vector y in buffer object. Counted in elements.
[in]	incy	Increment for the elements of y. It cannot be zero.
[in]	numCommandQueues	Number of OpenCL command queues in which the task is to be performed.
[in]	commandQueues	OpenCL command queues.
[in]	numEventsInWaitList	Number of events in the event wait list.
[in]	eventWaitList	Event wait list.
[in]	events	Event objects per each command queue that identify a particular kernel execution instance.

Returns

• clblasSuccess on success;
• clblasInvalidValue if offA exceeds the size of A buffer object;
• the same error codes as the clblasSgemv() function otherwise.

Examples:

example_sgemv.c.

clblasStatus clblasZgemv	(	clblasOrder	order,
		clblasTranspose	transA,
		size_t	M,
		size_t	N,
		DoubleComplex	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	x,
		size_t	offx,
		int	incx,
		DoubleComplex	beta,
		cl_mem	y,
		size_t	offy,
		int	incy,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Matrix-vector product with a general rectangular matrix and double complex elements. Extended version.

Matrix-vector products:

• \( y \leftarrow \alpha A x + \beta y \)
• \( y \leftarrow \alpha A^T x + \beta y \)

Parameters

[in]	order	Row/column order.
[in]	transA	How matrix A is to be transposed.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	The factor of matrix A.
[in]	A	Buffer object storing matrix A.
[in]	offA	Offset of the first element of the matrix A in the buffer object. Counted in elements.
[in]	lda	Leading dimension of matrix A. For a detailed description, see clblasSgemv().
[in]	x	Buffer object storing vector x.
[in]	offx	Offset of first element of vector x in buffer object. Counted in elements.
[in]	incx	Increment for the elements of x. It cannot be zero.
[in]	beta	The factor of the vector y.
[out]	y	Buffer object storing the vector y.
[in]	offy	Offset of first element of vector y in buffer object. Counted in elements.
[in]	incy	Increment for the elements of y. It cannot be zero.
[in]	numCommandQueues	Number of OpenCL command queues in which the task is to be performed.
[in]	commandQueues	OpenCL command queues.
[in]	numEventsInWaitList	Number of events in the event wait list.
[in]	eventWaitList	Event wait list.
[in]	events	Event objects per each command queue that identify a particular kernel execution instance.

Returns

• clblasSuccess on success;
• clblasInvalidDevice if a target device does not support the floating point arithmetic with double precision;
• clblasInvalidValue if offA exceeds the size of A buffer object;
• the same error codes as the clblasSgemv() function otherwise.