Native precision math functions

In SYCL the implementation-defined precision math functions are defined in the namespace sycl::native. The functions that are available within this namespace are specified in the list below.

The range of valid input values and the maximum error for these functions is implementation defined.

cos

Overloads 1

float cos(float x);

Returns: The cosine of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ cos(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the cosine of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

divide

Overloads 1

float divide(float x, float y);

Returns: The value x / y.

Overloads 2

template<typename NonScalar1, typename NonScalar2>
/*return-type*/ divide(NonScalar1 x, NonScalar2 y);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x and y, the value x[i] / y[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

exp

Overloads 1

float exp(float x);

Returns: The base-e exponential of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ exp(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the base-e exponential of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

exp2

Overloads 1

float exp2(float x);

Returns: The base-2 exponential of x.

Overloads 2

template<typename NonScalar>;
/*return-type*/ exp2(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the base-2 exponential of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

exp10

Overloads 1

float exp10(float x);

Returns: The base-10 exponential of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ exp10(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the base-10 exponential of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

log

Overloads 1

float log(float x);

Returns: The natural logarithm of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ log(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the natural logarithm of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

log2

Overloads 1

float log2(float x);

Returns: The base 2 logarithm of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ log2(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the base 2 logarithm of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

log10

Overloads 1

float log10(float x);

Returns: The base 10 logarithm of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ log10(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the base 10 logarithm of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

powr

Overloads 1

float powr(float x, float y);

Preconditions: The value of x must be greater than or equal to zero.

Returns: The value of x raised to the power y.

Overloads 2

template<typename NonScalar1, typename NonScalar2>
/*return-type*/ powr(NonScalar1 x, NonScalar2 y);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Preconditions: Each element of x must be greater than or equal to zero.

Returns: For each element of x and y, the value of x[i] raised to the power y[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

recip

Overloads 1

float recip(float x);

Returns: The reciprocal of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ recip(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the reciprocal of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

rsqrt

Overloads 1

float rsqrt(float x);

Returns: The inverse square root of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ rsqrt(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the inverse square root of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

sin

Overloads 1

float sin(float x);

Returns: The sine of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ sin(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the sine of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

sqrt

Overloads 1

float sqrt(float x);

Returns: The square root of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ sqrt(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the square root of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.

tan

Overloads 1

float tan(float x);

Returns: The tangent of x.

Overloads 2

template<typename NonScalar>
/*return-type*/ tan(NonScalar x);

Constraints: Available only if all of the following conditions are met:

• NonScalar is marray, vec, or the __swizzled_vec__ type; and

• The element type is float.

Returns: For each element of x, the tangent of x[i].

The return type is NonScalar unless NonScalar is the __swizzled_vec__ type, in which case the return type is the corresponding vec.