nrm2 (USM Version)¶
Computes the Euclidean norm of a vector.
Description¶
The nrm2
routines computes Euclidean norm of a vector
where:
x
is a vector ofn
elements.
API¶
Syntax¶
event nrm2(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 nrm2
supports the following precisions and devices.
T |
T_res |
Devices Supported |
---|---|---|
|
|
Host, CPU, and GPU |
|
|
Host, CPU, and GPU |
|
|
Host, CPU, and GPU |
|
|
Host, CPU, and GPU |
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 input vectrox
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 where the Euclidean norm of the vector
x
will be stored.
Return Values¶
Output event to wait on to ensure computation is complete.