nrm2

Computes the Euclidean norm of a vector.

Syntax

void nrm2(queue &exec_queue, std::int64_t n, buffer<T, 1> &x, std::int64_t incx, buffer<T_res, 1> &result)

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

Buffer holding input vector x. The buffer must be of size at least (1 + (n - 1)*abs(incx)). See Matrix and Vector Storage for more details.

incx

Stride of vector x.

Output Parameters

result

Buffer where the Euclidean norm of the vector x will be stored.