ROTG - Constructs givens plane rotation

Functions
clblasStatus	clblasSrotg (cl_mem SA, size_t offSA, cl_mem SB, size_t offSB, cl_mem C, size_t offC, cl_mem S, size_t offS, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	construct givens plane rotation on float elements More...
clblasStatus	clblasDrotg (cl_mem DA, size_t offDA, cl_mem DB, size_t offDB, cl_mem C, size_t offC, cl_mem S, size_t offS, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	construct givens plane rotation on double elements More...
clblasStatus	clblasCrotg (cl_mem CA, size_t offCA, cl_mem CB, size_t offCB, cl_mem C, size_t offC, cl_mem S, size_t offS, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	construct givens plane rotation on float-complex elements More...
clblasStatus	clblasZrotg (cl_mem CA, size_t offCA, cl_mem CB, size_t offCB, cl_mem C, size_t offC, cl_mem S, size_t offS, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	construct givens plane rotation on double-complex elements More...

Detailed Description

Function Documentation

clblasStatus clblasCrotg	(	cl_mem	CA,
		size_t	offCA,
		cl_mem	CB,
		size_t	offCB,
		cl_mem	C,
		size_t	offC,
		cl_mem	S,
		size_t	offS,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

construct givens plane rotation on float-complex elements

Parameters

[out]	CA	Buffer object that contains CA
[in]	offCA	Offset to CA in CA buffer object. Counted in elements.
[out]	CB	Buffer object that contains CB
[in]	offCB	Offset to CB in CB buffer object. Counted in elements.
[out]	C	Buffer object that contains C. C is real.
[in]	offC	Offset to C in C buffer object. Counted in elements.
[out]	S	Buffer object that contains S
[in]	offS	Offset to S in S buffer object. Counted in elements.
[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;
• the same error codes as the clblasSrotg() function otherwise.

clblasStatus clblasDrotg	(	cl_mem	DA,
		size_t	offDA,
		cl_mem	DB,
		size_t	offDB,
		cl_mem	C,
		size_t	offC,
		cl_mem	S,
		size_t	offS,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

construct givens plane rotation on double elements

Parameters

[out]	DA	Buffer object that contains DA
[in]	offDA	Offset to DA in DA buffer object. Counted in elements.
[out]	DB	Buffer object that contains DB
[in]	offDB	Offset to DB in DB buffer object. Counted in elements.
[out]	C	Buffer object that contains C
[in]	offC	Offset to C in C buffer object. Counted in elements.
[out]	S	Buffer object that contains S
[in]	offS	Offset to S in S buffer object. Counted in elements.
[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;
• the same error codes as the clblasSrotg() function otherwise.

clblasStatus clblasSrotg	(	cl_mem	SA,
		size_t	offSA,
		cl_mem	SB,
		size_t	offSB,
		cl_mem	C,
		size_t	offC,
		cl_mem	S,
		size_t	offS,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

construct givens plane rotation on float elements

Parameters

[out]	SA	Buffer object that contains SA
[in]	offSA	Offset to SA in SA buffer object. Counted in elements.
[out]	SB	Buffer object that contains SB
[in]	offSB	Offset to SB in SB buffer object. Counted in elements.
[out]	C	Buffer object that contains C
[in]	offC	Offset to C in C buffer object. Counted in elements.
[out]	S	Buffer object that contains S
[in]	offS	Offset to S in S buffer object. Counted in elements.
[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;
• clblasInvalidMemObject if either SA, SB, C or S object is Invalid, or an image object rather than the buffer one;
• clblasOutOfHostMemory if the library can't allocate memory for internal structures;
• clblasInvalidCommandQueue if the passed command queue is invalid;
• clblasInvalidContext if a context a passed command queue belongs to was released;
• clblasInvalidOperation if kernel compilation relating to a previous call has not completed for any of the target devices;
• clblasCompilerNotAvailable if a compiler is not available;
• clblasBuildProgramFailure if there is a failure to build a program executable.

Examples:

example_srotg.c.

clblasStatus clblasZrotg	(	cl_mem	CA,
		size_t	offCA,
		cl_mem	CB,
		size_t	offCB,
		cl_mem	C,
		size_t	offC,
		cl_mem	S,
		size_t	offS,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

construct givens plane rotation on double-complex elements

Parameters

[out]	CA	Buffer object that contains CA
[in]	offCA	Offset to CA in CA buffer object. Counted in elements.
[out]	CB	Buffer object that contains CB
[in]	offCB	Offset to CB in CB buffer object. Counted in elements.
[out]	C	Buffer object that contains C. C is real.
[in]	offC	Offset to C in C buffer object. Counted in elements.
[out]	S	Buffer object that contains S
[in]	offS	Offset to S in S buffer object. Counted in elements.
[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;
• the same error codes as the clblasDrotg() function otherwise.