clBLAS 2.0
Loading...
Searching...
No Matches
ROT - Apply givens rotation

Functions

clblasStatus clblasSrot (size_t N, cl_mem X, size_t offx, int incx, cl_mem Y, size_t offy, int incy, cl_float C, cl_float S, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 applies a plane rotation for float elements
 
clblasStatus clblasDrot (size_t N, cl_mem X, size_t offx, int incx, cl_mem Y, size_t offy, int incy, cl_double C, cl_double S, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 applies a plane rotation for double elements
 
clblasStatus clblasCsrot (size_t N, cl_mem X, size_t offx, int incx, cl_mem Y, size_t offy, int incy, cl_float C, cl_float S, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 applies a plane rotation for float-complex elements
 
clblasStatus clblasZdrot (size_t N, cl_mem X, size_t offx, int incx, cl_mem Y, size_t offy, int incy, cl_double C, cl_double S, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 applies a plane rotation for double-complex elements
 

Detailed Description

Function Documentation

◆ clblasCsrot()

clblasStatus clblasCsrot ( size_t N,
cl_mem X,
size_t offx,
int incx,
cl_mem Y,
size_t offy,
int incy,
cl_float C,
cl_float S,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

applies a plane rotation for float-complex elements

Parameters
[in]NNumber of elements in vector X and Y.
[out]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object. Counted in elements.
[in]incxIncrement for the elements of X. Must not be zero.
[out]YBuffer object storing the vector Y.
[in]offyOffset of first element of vector Y in buffer object. Counted in elements.
[in]incyIncrement for the elements of Y. Must not be zero.
[in]CC specifies the cosine, cos. This number is real
[in]SS specifies the sine, sin. This number is real
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent objects per each command queue that identify a particular kernel execution instance.
Returns
  • clblasSuccess on success;
  • the same error codes as the clblasSrot() function otherwise.

◆ clblasDrot()

clblasStatus clblasDrot ( size_t N,
cl_mem X,
size_t offx,
int incx,
cl_mem Y,
size_t offy,
int incy,
cl_double C,
cl_double S,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

applies a plane rotation for double elements

Parameters
[in]NNumber of elements in vector X and Y.
[out]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object. Counted in elements.
[in]incxIncrement for the elements of X. Must not be zero.
[out]YBuffer object storing the vector Y.
[in]offyOffset of first element of vector Y in buffer object. Counted in elements.
[in]incyIncrement for the elements of Y. Must not be zero.
[in]CC specifies the cosine, cos.
[in]SS specifies the sine, sin.
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent 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 clblasSrot() function otherwise.

◆ clblasSrot()

clblasStatus clblasSrot ( size_t N,
cl_mem X,
size_t offx,
int incx,
cl_mem Y,
size_t offy,
int incy,
cl_float C,
cl_float S,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

applies a plane rotation for float elements

Parameters
[in]NNumber of elements in vector X and Y.
[out]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object. Counted in elements.
[in]incxIncrement for the elements of X. Must not be zero.
[out]YBuffer object storing the vector Y.
[in]offyOffset of first element of vector Y in buffer object. Counted in elements.
[in]incyIncrement for the elements of Y. Must not be zero.
[in]CC specifies the cosine, cos.
[in]SS specifies the sine, sin.
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent 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_srot.c.

◆ clblasZdrot()

clblasStatus clblasZdrot ( size_t N,
cl_mem X,
size_t offx,
int incx,
cl_mem Y,
size_t offy,
int incy,
cl_double C,
cl_double S,
cl_uint numCommandQueues,
cl_command_queue * commandQueues,
cl_uint numEventsInWaitList,
const cl_event * eventWaitList,
cl_event * events )

applies a plane rotation for double-complex elements

Parameters
[in]NNumber of elements in vector X and Y.
[out]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object. Counted in elements.
[in]incxIncrement for the elements of X. Must not be zero.
[out]YBuffer object storing the vector Y.
[in]offyOffset of first element of vector Y in buffer object. Counted in elements.
[in]incyIncrement for the elements of Y. Must not be zero.
[in]CC specifies the cosine, cos. This number is real
[in]SS specifies the sine, sin. This number is real
[in]numCommandQueuesNumber of OpenCL command queues in which the task is to be performed.
[in]commandQueuesOpenCL command queues.
[in]numEventsInWaitListNumber of events in the event wait list.
[in]eventWaitListEvent wait list.
[in]eventsEvent 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 clblasSrot() function otherwise.