nrm2 (USM Version)

Computes the Euclidean norm of a vector.

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

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 nrm2 routines computes Euclidean norm of a vector

result = ||x||,

where:

x is a vector of 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 input vectro x 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.