Skip to content

Latest commit

 

History

History
107 lines (60 loc) · 2.39 KB

get_status.rst

File metadata and controls

107 lines (60 loc) · 2.39 KB
Raw

get_status

Gets the VM status.

Syntax

namespace oneapi::mkl::vm {

    oneapi::mkl::vm::status get_status(
        sycl::queue& exec_queue);

} // namespace oneapi::mkl::vm

Description

The get_status function gets the VM status for a given queue.

The global VM status is a single value and it registers the bitwise-OR of status codes that happened inside VM functions run on the specific queue. For performance reasons, it might be done in non-atomic manner. The possible status codes are listed in the table below.

Status Description
Successful Execution  
oneapi::mkl::vm::status::success VM function execution completed successfully
oneapi::mkl::vm::status::not_defined VM status not defined
Warnings  
oneapi::mkl::vm::status::accuracy_warning VM function execution completed successfully in a different accuracy mode
Computational status codes  
oneapi::mkl::vm::status::errdom Values are out of a range of definition producing invalid (QNaN) result
oneapi::mkl::vm::status::sing Values cause divide-by-zero (singularity) computational errors and produce and invalid (QNaN or Inf) result
oneapi::mkl::vm::status::overflow An overflow happened during the calculation process
oneapi::mkl::vm::status::underflow An underflow happened during the calculation process

Input Parameters

exec_queue
The queue where the routine should be executed.

Output Parameters

return value (status)
Specifies the VM status.