DOT - Dot product of two vectors¶

pyclblas.clblasDdot(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasDdot

dot product of two vectors containing double elements

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.

pyclblas.clblasSdot(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasSdot

dot product of two vectors containing float elements

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.

pyclblas.clblasCdotu(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasCdotu

dot product of two vectors containing float-complex elements

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.

pyclblas.clblasZdotu(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasZdotu

dot product of two vectors containing double-complex elements

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.

pyclblas.clblasCdotc(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasCdotc

dot product of two vectors containing float-complex elements conjugating the first vector

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.

pyclblas.clblasZdotc(N, dotProduct, offDP, X, offx, incx, Y, offy, incy, scratchBuff, commandQueues, eventWaitList)¶

wraps: clblasZdotc

dot product of two vectors containing double-complex elements conjugating the first vector

Parameters:

N (int [in]) – Number of elements in vector X.
dotProduct (pyopencl.Buffer [out]) – Buffer object that will contain the dot-product value.
offDP (int [in]) – Offset to dot-product in dotProduct buffer object. Counted in elements.
X (pyopencl.Buffer [in]) – Buffer object storing vector X.
offx (int [in]) – Offset of first element of vector X in buffer object. Counted in elements.
incx (int [in]) – Increment for the elements of X. Must not be zero.
Y (pyopencl.Buffer [in]) – Buffer object storing the vector Y.
offy (int [in]) – Offset of first element of vector Y in buffer object. Counted in elements.
incy (int [in]) – Increment for the elements of Y. Must not be zero.
scratchBuff (pyopencl.Buffer [in]) – Temporary cl_mem scratch buffer object of minimum size N.
commandQueues (pyopencl.CommandQueue [in]) – OpenCL command queues. A list, tuple, or single instance of pyopencl.CommandQueue. Must not be None.
eventWaitList (pyopencl.Event [in]) – Event wait list. A list, tuple, or single instance of pyopencl.Event. May be None.

Returns:

A tuple of pyopencl.Event instances, one for each commandQueue supplied.