GERC - General matrix rank 1 operation

Functions
clblasStatus	clblasCgerc (clblasOrder order, size_t M, size_t N, cl_float2 alpha, const cl_mem X, size_t offx, int incx, const cl_mem Y, size_t offy, int incy, cl_mem A, size_t offa, size_t lda, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	vector-vector product with float complex elements and performs the rank 1 operation A More...
clblasStatus	clblasZgerc (clblasOrder order, size_t M, size_t N, cl_double2 alpha, const cl_mem X, size_t offx, int incx, const cl_mem Y, size_t offy, int incy, cl_mem A, size_t offa, size_t lda, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	vector-vector product with double complex elements and performs the rank 1 operation A More...

Detailed Description

Function Documentation

clblasStatus clblasCgerc	(	clblasOrder	order,
		size_t	M,
		size_t	N,
		cl_float2	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		const cl_mem	Y,
		size_t	offy,
		int	incy,
		cl_mem	A,
		size_t	offa,
		size_t	lda,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

vector-vector product with float complex elements and performs the rank 1 operation A

Vector-vector products:

• \( A \leftarrow \alpha X Y^H + A \)

Parameters

[in]	order	Row/column order.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	specifies the scalar alpha.
[in]	X	Buffer object storing vector X.
[in]	offx	Offset in number of elements for the first element in vector X.
[in]	incx	Increment for the elements of X. Must not be zero.
[in]	Y	Buffer object storing vector Y.
[in]	offy	Offset in number of elements for the first element in vector Y.
[in]	incy	Increment for the elements of Y. Must not be zero.
[out]	A	Buffer object storing matrix A. On exit, A is overwritten by the updated matrix.
[in]	offa	Offset in number of elements for the first element in matrix A.
[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]	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;
• clblasNotInitialized if clblasSetup() was not called;
• clblasInvalidValue if invalid parameters are passed:
  • M, N or
  • either incx or incy is zero, or
  • a leading dimension is invalid;
• clblasInvalidMemObject if A, X, or Y object is invalid, or an image object rather than the buffer one;
• clblasOutOfResources if you use image-based function implementation and no suitable scratch image available;
• clblasOutOfHostMemory if the library can't allocate memory for internal structures;
• clblasInvalidCommandQueue if the passed command queue is invalid;
• clblasInvalidContext if a context a passed command queue belongs to was released;
• clblasInvalidOperation if kernel compilation relating to a previous call has not completed for any of the target devices;
• clblasCompilerNotAvailable if a compiler is not available;
• clblasBuildProgramFailure if there is a failure to build a program executable.

clblasStatus clblasZgerc	(	clblasOrder	order,
		size_t	M,
		size_t	N,
		cl_double2	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		const cl_mem	Y,
		size_t	offy,
		int	incy,
		cl_mem	A,
		size_t	offa,
		size_t	lda,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

vector-vector product with double complex elements and performs the rank 1 operation A

Vector-vector products:

• \( A \leftarrow \alpha X Y^H + A \)

Parameters

[in]	order	Row/column order.
[in]	M	Number of rows in matrix A.
[in]	N	Number of columns in matrix A.
[in]	alpha	specifies the scalar alpha.
[in]	X	Buffer object storing vector X.
[in]	offx	Offset in number of elements for the first element in vector X.
[in]	incx	Increment for the elements of X. Must not be zero.
[in]	Y	Buffer object storing vector Y.
[in]	offy	Offset in number of elements for the first element in vector Y.
[in]	incy	Increment for the elements of Y. Must not be zero.
[out]	A	Buffer object storing matrix A. On exit, A is overwritten by the updated matrix.
[in]	offa	Offset in number of elements for the first element in matrix A.
[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]	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 floating point arithmetic with double precision;
• the same error codes as the clblasCgerc() function otherwise.