SYR2K - Symmetric rank-2k update to a matrix

Functions
clblasStatus	clblasSsyr2k (clblasOrder order, clblasUplo uplo, clblasTranspose transAB, size_t N, size_t K, cl_float alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem B, size_t offB, size_t ldb, cl_float beta, cl_mem C, size_t offC, size_t ldc, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Rank-2k update of a symmetric matrix with float elements. Extended version. More...
clblasStatus	clblasDsyr2k (clblasOrder order, clblasUplo uplo, clblasTranspose transAB, size_t N, size_t K, cl_double alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem B, size_t offB, size_t ldb, cl_double beta, cl_mem C, size_t offC, size_t ldc, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Rank-2k update of a symmetric matrix with double elements. Extended version. More...
clblasStatus	clblasCsyr2k (clblasOrder order, clblasUplo uplo, clblasTranspose transAB, size_t N, size_t K, FloatComplex alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem B, size_t offB, size_t ldb, FloatComplex beta, cl_mem C, size_t offC, size_t ldc, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Rank-2k update of a symmetric matrix with complex float elements. Extended version. More...
clblasStatus	clblasZsyr2k (clblasOrder order, clblasUplo uplo, clblasTranspose transAB, size_t N, size_t K, DoubleComplex alpha, const cl_mem A, size_t offA, size_t lda, const cl_mem B, size_t offB, size_t ldb, DoubleComplex beta, cl_mem C, size_t offC, size_t ldc, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Rank-2k update of a symmetric matrix with complex double elements. Extended version. More...

Detailed Description

Function Documentation

clblasStatus clblasCsyr2k	(	clblasOrder	order,
		clblasUplo	uplo,
		clblasTranspose	transAB,
		size_t	N,
		size_t	K,
		FloatComplex	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	B,
		size_t	offB,
		size_t	ldb,
		FloatComplex	beta,
		cl_mem	C,
		size_t	offC,
		size_t	ldc,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Rank-2k update of a symmetric matrix with complex float elements. Extended version.

Rank-k updates:

• \( C \leftarrow \alpha A B^T + \alpha B A^T + \beta C \)
• \( C \leftarrow \alpha A^T B + \alpha B^T A \beta C \)

where C is a symmetric matrix.

Parameters

[in]	order	Row/column order.
[in]	uplo	The triangle in matrix C being referenced.
[in]	transAB	How matrices A and B is to be transposed.
[in]	N	Number of rows and columns in matrix C.
[in]	K	Number of columns of the matrices A and B if they are not transposed, and number of rows otherwise.
[in]	alpha	The factor of matrices A and B.
[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 detailed description, see clblasSsyr2k().
[in]	B	Buffer object storing matrix B.
[in]	offB	Offset of the first element of the matrix B in the buffer object. Counted in elements.
[in]	ldb	Leading dimension of matrix B. For detailed description, see clblasSsyr2k().
[in]	beta	The factor of matrix C.
[out]	C	Buffer object storing matrix C.
[in]	offC	Offset of the first element of the matrix C in the buffer object. Counted in elements.
[in]	ldc	Leading dimension of matrix C. It cannot be less than N.
[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 either offA, offB or offC exceeds the size of the respective buffer object;
• clblasInvalidValue if transAB is set to clblasConjTrans.
• the same error codes as the clblasSsyr2k() function otherwise.

clblasStatus clblasDsyr2k	(	clblasOrder	order,
		clblasUplo	uplo,
		clblasTranspose	transAB,
		size_t	N,
		size_t	K,
		cl_double	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	B,
		size_t	offB,
		size_t	ldb,
		cl_double	beta,
		cl_mem	C,
		size_t	offC,
		size_t	ldc,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Rank-2k update of a symmetric matrix with double elements. Extended version.

Rank-k updates:

• \( C \leftarrow \alpha A B^T + \alpha B A^T + \beta C \)
• \( C \leftarrow \alpha A^T B + \alpha B^T A \beta C \)

where C is a symmetric matrix.

Parameters

[in]	order	Row/column order.
[in]	uplo	The triangle in matrix C being referenced.
[in]	transAB	How matrices A and B is to be transposed.
[in]	N	Number of rows and columns in matrix C.
[in]	K	Number of columns of the matrices A and B if they are not transposed, and number of rows otherwise.
[in]	alpha	The factor of matrices A and B.
[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 detailed description, see clblasSsyr2k().
[in]	B	Buffer object storing matrix B.
[in]	offB	Offset of the first element of the matrix B in the buffer object. Counted in elements.
[in]	ldb	Leading dimension of matrix B. For detailed description, see clblasSsyr2k().
[in]	beta	The factor of matrix C.
[out]	C	Buffer object storing matrix C.
[in]	offC	Offset of the first element of the matrix C in the buffer object. Counted in elements.
[in]	ldc	Leading dimension of matrix C. It cannot be less than N.
[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;
• clblasInvalidValue if either offA, offB or offC exceeds the size of the respective buffer object;
• the same error codes as the clblasSsyr2k() function otherwise.

clblasStatus clblasSsyr2k	(	clblasOrder	order,
		clblasUplo	uplo,
		clblasTranspose	transAB,
		size_t	N,
		size_t	K,
		cl_float	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	B,
		size_t	offB,
		size_t	ldb,
		cl_float	beta,
		cl_mem	C,
		size_t	offC,
		size_t	ldc,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Rank-2k update of a symmetric matrix with float elements. Extended version.

Rank-k updates:

• \( C \leftarrow \alpha A B^T + \alpha B A^T + \beta C \)
• \( C \leftarrow \alpha A^T B + \alpha B^T A \beta C \)

where C is a symmetric matrix.

Parameters

[in]	order	Row/column order.
[in]	uplo	The triangle in matrix C being referenced.
[in]	transAB	How matrices A and B is to be transposed.
[in]	N	Number of rows and columns in matrix C.
[in]	K	Number of columns of the matrices A and B if they are not transposed, and number of rows otherwise.
[in]	alpha	The factor of matrices A and B.
[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 K if A is in the row-major format, and less than N otherwise.
[in]	B	Buffer object storing matrix B.
[in]	offB	Offset of the first element of the matrix B in the buffer object. Counted in elements.
[in]	ldb	Leading dimension of matrix B. It cannot be less less than K if B matches to the op(B) matrix in the row-major format, and less than N otherwise.
[in]	beta	The factor of matrix C.
[out]	C	Buffer object storing matrix C.
[in]	offC	Offset of the first element of the matrix C in the buffer object. Counted in elements.
[in]	ldc	Leading dimension of matrix C. It cannot be less than N.
[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 either offA, offB or offC exceeds the size of the respective buffer object;
• the same error codes as the clblasSsyr2k() function otherwise.

Examples:

example_ssyr2k.c.

clblasStatus clblasZsyr2k	(	clblasOrder	order,
		clblasUplo	uplo,
		clblasTranspose	transAB,
		size_t	N,
		size_t	K,
		DoubleComplex	alpha,
		const cl_mem	A,
		size_t	offA,
		size_t	lda,
		const cl_mem	B,
		size_t	offB,
		size_t	ldb,
		DoubleComplex	beta,
		cl_mem	C,
		size_t	offC,
		size_t	ldc,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Rank-2k update of a symmetric matrix with complex double elements. Extended version.

Rank-k updates:

• \( C \leftarrow \alpha A B^T + \alpha B A^T + \beta C \)
• \( C \leftarrow \alpha A^T B + \alpha B^T A \beta C \)

where C is a symmetric matrix.

Parameters

[in]	order	Row/column order.
[in]	uplo	The triangle in matrix C being referenced.
[in]	transAB	How matrices A and B is to be transposed.
[in]	N	Number of rows and columns in matrix C.
[in]	K	Number of columns of the matrices A and B if they are not transposed, and number of rows otherwise.
[in]	alpha	The factor of matrices A and B.
[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 detailed description, see clblasSsyr2k().
[in]	B	Buffer object storing matrix B.
[in]	offB	Offset of the first element of the matrix B in the buffer object. Counted in elements.
[in]	ldb	Leading dimension of matrix B. For detailed description, see clblasSsyr2k().
[in]	beta	The factor of matrix C.
[out]	C	Buffer object storing matrix C.
[in]	offC	Offset of the first element of the matrix C in the buffer object. Counted in elements.
[in]	ldc	Leading dimension of matrix C. It cannot be less than N.
[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;
• clblasInvalidValue if either offA, offB or offC exceeds the size of the respective buffer object;
• clblasInvalidValue if transAB is set to clblasConjTrans.
• the same error codes as the clblasSsyr2k() function otherwise.