asum (USM Version)¶
Computes the sum of magnitudes of the vector elements.
Syntax
namespace oneapi::mkl::vm {
event asum(queue &exec_queue,
std::int64_t n, const T *x,
std::int64_t incx, T_res *result,
const vector_class<event> &dependencies = {} )
}
The USM version of ``asum`` supports the following precisions and
devices.
.. list-table::
:header-rows: 1
* - T
- T_res
- Devices Supported
* - ``float``
- ``float``
- Host, CPU, and GPU
* - ``double``
- ``double``
- Host, CPU, and GPU
* - ``std::complex<float>``
- ``float``
- Host, CPU, and GPU
* - ``std::complex<double>``
- ``double``
- Host, CPU, and GPU
Description
The asum routine computes the sum of the magnitudes of elements of a real vector, or the sum of magnitudes of the real and imaginary parts of elements of a complex vector:
\mathrm{result} = \sum_{i=1}^n \left( |\mathrm{Re} (X_i)| + |\mathrm{Im}(X_i)| \right)
where x
is a vector with n
elements.
Input Parameters
- exec_queue
The queue where the routine should be executed.
- n
Number of elements in vector
x
.- x
Pointer to input vector
x
. The array holding the vectorx
must be of size at least (1 + (n
- 1)*abs(incx
)). See Matrix and Vector Storage for more details.- incx
Stride of vector x.
- dependencies
List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- result
Pointer to the output matrix where the scalar result is stored (the sum of magnitudes of the real and imaginary parts of all elements of the vector).
Return Values
Output event to wait on to ensure computation is complete.