clBLAS  2.11
 All Functions Typedefs Enumerations Enumerator Groups Pages
Functions
ASUM - Sum of absolute values

Functions

clblasStatus clblasSasum (size_t N, cl_mem asum, size_t offAsum, const cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 absolute sum of values of a vector containing float elements More...
 
clblasStatus clblasDasum (size_t N, cl_mem asum, size_t offAsum, const cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 absolute sum of values of a vector containing double elements More...
 
clblasStatus clblasScasum (size_t N, cl_mem asum, size_t offAsum, const cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 absolute sum of values of a vector containing float-complex elements More...
 
clblasStatus clblasDzasum (size_t N, cl_mem asum, size_t offAsum, const cl_mem X, size_t offx, int incx, cl_mem scratchBuff, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 absolute sum of values of a vector containing double-complex elements More...
 

Detailed Description

Function Documentation

clblasStatus clblasDasum ( size_t  N,
cl_mem  asum,
size_t  offAsum,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  scratchBuff,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

absolute sum of values of a vector containing double elements

Parameters
[in]NNumber of elements in vector X.
[out]asumBuffer object that will contain the absoulte sum value
[in]offAsumOffset to absoule sum in asum buffer object. Counted in elements.
[in]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.
[in]scratchBuffTemporary cl_mem scratch buffer object of minimum size N
[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 clblasSasum() function otherwise.
clblasStatus clblasDzasum ( size_t  N,
cl_mem  asum,
size_t  offAsum,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  scratchBuff,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

absolute sum of values of a vector containing double-complex elements

Parameters
[in]NNumber of elements in vector X.
[out]asumBuffer object that will contain the absolute sum value
[in]offAsumOffset to absolute sum in asum buffer object. Counted in elements.
[in]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.
[in]scratchBuffTemporary cl_mem scratch buffer object of minimum size N
[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 clblasSasum() function otherwise.
clblasStatus clblasSasum ( size_t  N,
cl_mem  asum,
size_t  offAsum,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  scratchBuff,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

absolute sum of values of a vector containing float elements

Parameters
[in]NNumber of elements in vector X.
[out]asumBuffer object that will contain the absoule sum value
[in]offAsumOffset to absolute sum in asum buffer object. Counted in elements.
[in]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.
[in]scratchBuffTemporary cl_mem scratch buffer object of minimum size N
[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 is zero, or
    • the vector sizes along with the increments lead to accessing outside of any of the buffers;
  • clblasInvalidMemObject if any of X or asum or scratchBuff 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_sasum.c.
clblasStatus clblasScasum ( size_t  N,
cl_mem  asum,
size_t  offAsum,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  scratchBuff,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

absolute sum of values of a vector containing float-complex elements

Parameters
[in]NNumber of elements in vector X.
[out]asumBuffer object that will contain the absolute sum value
[in]offAsumOffset to absolute sum in asum buffer object. Counted in elements.
[in]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.
[in]scratchBuffTemporary cl_mem scratch buffer object of minimum size N
[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 clblasSasum() function otherwise.