clBLAS  2.11
 All Functions Typedefs Enumerations Enumerator Groups Pages
Functions
SPR - Symmetric packed matrix rank 1 update

Functions

clblasStatus clblasSspr (clblasOrder order, clblasUplo uplo, size_t N, cl_float alpha, const cl_mem X, size_t offx, int incx, cl_mem AP, size_t offa, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Symmetric rank 1 operation with a general triangular packed-matrix and float elements. More...
 
clblasStatus clblasDspr (clblasOrder order, clblasUplo uplo, size_t N, cl_double alpha, const cl_mem X, size_t offx, int incx, cl_mem AP, size_t offa, cl_uint numCommandQueues, cl_command_queue *commandQueues, cl_uint numEventsInWaitList, const cl_event *eventWaitList, cl_event *events)
 Symmetric rank 1 operation with a general triangular packed-matrix and double elements. More...
 

Detailed Description

The Level 2 Basic Linear Algebra Subprograms are functions that perform symmetric rank 1 update operations on packed matrix

Function Documentation

clblasStatus clblasDspr ( clblasOrder  order,
clblasUplo  uplo,
size_t  N,
cl_double  alpha,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  AP,
size_t  offa,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

Symmetric rank 1 operation with a general triangular packed-matrix and double elements.

Symmetric rank 1 operation:

  • \( A \leftarrow \alpha X X^T + A \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]NNumber of columns in matrix A.
[in]alphaThe factor of matrix A.
[in]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object.
[in]incxIncrement for the elements of X. Must not be zero.
[out]APBuffer object storing packed-matrix AP.
[in]offaOffset of first element of matrix AP in buffer object.
[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 floating point arithmetic with double precision;
  • the same error codes as the clblasSspr() function otherwise.
clblasStatus clblasSspr ( clblasOrder  order,
clblasUplo  uplo,
size_t  N,
cl_float  alpha,
const cl_mem  X,
size_t  offx,
int  incx,
cl_mem  AP,
size_t  offa,
cl_uint  numCommandQueues,
cl_command_queue *  commandQueues,
cl_uint  numEventsInWaitList,
const cl_event *  eventWaitList,
cl_event *  events 
)

Symmetric rank 1 operation with a general triangular packed-matrix and float elements.

Symmetric rank 1 operation:

  • \( A \leftarrow \alpha X X^T + A \)
Parameters
[in]orderRow/column order.
[in]uploThe triangle in matrix being referenced.
[in]NNumber of columns in matrix A.
[in]alphaThe factor of matrix A.
[in]XBuffer object storing vector X.
[in]offxOffset of first element of vector X in buffer object.
[in]incxIncrement for the elements of X. Must not be zero.
[out]APBuffer object storing packed-matrix AP.
[in]offaOffset of first element of matrix AP in buffer object.
[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
  • clblasInvalidMemObject if either AP, X 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_sspr.c.