SCAL - Scales a vector by a constant

Functions
clblasStatus	clblasSscal (size_t N, cl_float alpha, cl_mem X, size_t offx, int incx, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Scales a float vector by a float constant. More...
clblasStatus	clblasDscal (size_t N, cl_double alpha, cl_mem X, size_t offx, int incx, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Scales a double vector by a double constant. More...
clblasStatus	clblasCscal (size_t N, cl_float2 alpha, cl_mem X, size_t offx, int incx, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Scales a complex-float vector by a complex-float constant. More...
clblasStatus	clblasZscal (size_t N, cl_double2 alpha, cl_mem X, size_t offx, int incx, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
	Scales a complex-double vector by a complex-double constant. More...

Detailed Description

Function Documentation

clblasStatus clblasCscal	(	size_t	N,
		cl_float2	alpha,
		cl_mem	X,
		size_t	offx,
		int	incx,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Scales a complex-float vector by a complex-float constant.

• \( X \leftarrow \alpha X \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[out]	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.
[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 clblasSscal() function otherwise.

clblasStatus clblasDscal	(	size_t	N,
		cl_double	alpha,
		cl_mem	X,
		size_t	offx,
		int	incx,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Scales a double vector by a double constant.

• \( X \leftarrow \alpha X \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[out]	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.
[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 clblasSscal() function otherwise.

clblasStatus clblasSscal	(	size_t	N,
		cl_float	alpha,
		cl_mem	X,
		size_t	offx,
		int	incx,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Scales a float vector by a float constant.

• \( X \leftarrow \alpha X \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[out]	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.
[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
  • incx 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_sscal.c.

clblasStatus clblasZscal	(	size_t	N,
		cl_double2	alpha,
		cl_mem	X,
		size_t	offx,
		int	incx,
		cl_uint	numCommandQueues,
		cl_command_queue *	commandQueues,
		cl_uint	numEventsInWaitList,
		const cl_event *	eventWaitList,
		cl_event *	events
	)

Scales a complex-double vector by a complex-double constant.

• \( X \leftarrow \alpha X \)

Parameters

[in]	N	Number of elements in vector X.
[in]	alpha	The constant factor for vector X.
[out]	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.
[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 clblasDscal() function otherwise.