hypot

Computes a square root of sum of two squared elements.

Syntax

Buffer API:

void hypot(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &b, buffer<T, 1> &y, uint64_t mode = mode::not_defined)

USM API:

event hypot(queue &exec_queue, int64_t n, T *a, T *b, T *y, vector_class<event> const &depends = {}, uint64_t mode = mode::not_defined)

hypot supports the following precisions and devices:

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

Description

The function hypot(a,b) computes a square root of sum of two squared elements.

Argument 1

Argument 2

Result

Error Code

+0

+0

+0

-0

-0

+0

+∞

any value

+∞

any value

+∞

+∞

SNAN

any value

QNAN

INVALID

any value

SNAN

QNAN

INVALID

QNAN

any value

QNAN

any value

QNAN

QNAN

Data Type

Threshold Limitations on Input Parameters

single precision

abs(a[i]) < sqrt(FLT_MAX) abs(b[i]) < sqrt(FLT_MAX)

double precision

abs(a[i]) < sqrt(DBL_MAX) abs(b[i]) < sqrt(DBL_MAX)

The hypot(a,b) function does not generate any errors.

Input Parameters

Buffer API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

The buffer a containing 1st input vector of size n.

b

The buffer b containing 2nd input vector of size n.

mode

Overrides the global VM mode setting for this function call. See set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

USM API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

Pointer a to the 1st input vector of size n.

b

Pointer b to the 2nd input vector of size n.

depends

Vector of dependent events (to wait for input data to be ready).

mode

Overrides the global VM mode setting for this function call. See the set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

Output Parameters

Buffer API:

y

The buffer y containing the output vector of size n.

USM API:

y

Pointer y to the output vector of size n.

return value (event)

Function end event.

Example

An example of how to use hypotcan be found in the Intel® oneMKL installation directory, under:

examples/sycl/vml/vhypot.cpp