nextafter

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-6C94F8F4-F00C-469F-BC9A-A225B0D2A3CD

View Details

nextafter

Computes the element-wise next representable floating-point value of vector a elements in the direction of vector b elements.

Description
API
Examples

Description

The nextafter(a,b) function returns a vector containing the next representable floating-point values following the first vector argument elements in the direction of the second vector argument’s corresponding elements.

Arguments/Results	Error Code
Input vector argument element is ﬁnite and the corresponding result vector element value is inﬁnite	`status::overflow`
Result vector element value is subnormal or zero, and different from the corresponding input vector argument element	`status::underflow`

Even though underﬂow or overﬂow can occur, the returned value is independent of the current rounding direction mode.

API

Syntax

Buffer API

namespace oneapi::mkl::vm {

sycl::event nextafter(sycl::queue & exec_queue,
      std::int64_t n,
      sycl::buffer<T> & a,
      sycl::buffer<T> & b,
      sycl::buffer<T> & y,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

namespace oneapi::mkl::vm {

sycl::event nextafter(sycl::queue & exec_queue,
      sycl::buffer<T> & a,
      oneapi::mkl::slice sa,
      sycl::buffer<T> & b,
      oneapi::mkl::slice sb,
      sycl::buffer<T> & y,
      oneapi::mkl::slice sy,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

USM API

namespace oneapi::mkl::vm {

sycl::event nextafter(sycl::queue & exec_queue,
      std::int64_t n,
      T const * a,
      T const * b,
      T * y,
      std::vector<sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

namespace oneapi::mkl::vm {

sycl::event nextafter(sycl::queue & exec_queue,
      T const * a,
      oneapi::mkl::slice sa,
      T const * b,
      oneapi::mkl::slice sb,
      T * y,
      oneapi::mkl::slice sy,
      std::vector<sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

nextafter supports the following precisions and devices:

T	Devices supported
`sycl::half`	GPU
`_Float16`	CPU
`float`	CPU and GPU
`double`	CPU and GPU

Input Parameters

Buffer API

exec_queue: The queue where the routine will be executed.
n: Specifies the number of elements to be calculated.
a: The buffer containing the 1st input vector.
sa: Slice selector for a. See Data Types for a description of the oneMKL slice type.
b: The buffer containing the 2nd input vector.
sb: Slice selector for b. See Data Types for a description of the oneMKL slice type.
sy: Slice selector for y. See Data Types for a description of the oneMKL slice type.
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.
errhandler: Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

USM API

exec_queue: The queue where the routine will be executed.
n: Specifies the number of elements to be calculated.
a: Pointer to the 1st input vector.
sa: Slice selector for a. See Data Types for a description of the oneMKL slice type.
b: Pointer to the 2nd input vector.
sb: Slice selector for b. See Data Types for a description of the oneMKL slice type.
sy: Slice selector for y. See Data Types for a description of the oneMKL slice type.
depends: Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.
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.
errhandler: Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

Output Parameters

Buffer API

y: The buffer containing the output vector.
return value (event): Computation end event.

USM API

y: Pointer to the output vector.
return value (event): Computation end event.

Examples

An example of how to use nextafter can be found in the oneMKL installation directory, under:

share/doc/mkl/examples/sycl/vml/source/vnextafter.cpp

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

nextafter

Description

API

Examples