AXPY - Scale X and add to Y

Functions
clblasStatus	clblasSaxpy (size_t N, cl_float alpha, const cl_mem X, size_t offx, int incx, 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)
	Scale vector X of float elements and add to Y. More...
clblasStatus	clblasDaxpy (size_t N, cl_double alpha, const cl_mem X, size_t offx, int incx, 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)
	Scale vector X of double elements and add to Y. More...
clblasStatus	clblasCaxpy (size_t N, cl_float2 alpha, const cl_mem X, size_t offx, int incx, 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)
	Scale vector X of complex-float elements and add to Y. More...
clblasStatus	clblasZaxpy (size_t N, cl_double2 alpha, const cl_mem X, size_t offx, int incx, 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)
	Scale vector X of double-complex elements and add to Y. More...

Detailed Description

Function Documentation

clblasStatus clblasCaxpy	(	size_t	N,
		cl_float2	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		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
	)

Scale vector X of complex-float elements and add to Y.

• \( Y \leftarrow \alpha X + Y \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[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. Must not be zero.
[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. Must not 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;
• the same error codes as the clblasSaxpy() function otherwise.

clblasStatus clblasDaxpy	(	size_t	N,
		cl_double	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		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
	)

Scale vector X of double elements and add to Y.

• \( Y \leftarrow \alpha X + Y \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[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. Must not be zero.
[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. Must not 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;
• the same error codes as the clblasSaxpy() function otherwise.

clblasStatus clblasSaxpy	(	size_t	N,
		cl_float	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		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
	)

Scale vector X of float elements and add to Y.

• \( Y \leftarrow \alpha X + Y \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[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. Must not be zero.
[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. Must not 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;
• clblasNotInitialized if clblasSetup() was not called;
• clblasInvalidValue if invalid parameters are passed:
  • N is zero, or
  • either incx or incy is zero, or
  • the vector sizes along with the increments lead to accessing outside of any of the buffers;
• clblasInvalidMemObject if either X, or Y 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_saxpy.c.

clblasStatus clblasZaxpy	(	size_t	N,
		cl_double2	alpha,
		const cl_mem	X,
		size_t	offx,
		int	incx,
		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
	)

Scale vector X of double-complex elements and add to Y.

• \( Y \leftarrow \alpha X + Y \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[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. Must not be zero.
[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. Must not 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;
• the same error codes as the clblasDaxpy() function otherwise.