set_status

set_status#

Sets the global VM status according to new value and returns the previous VM status.

Syntax

namespace oneapi::mkl::vm {

    oneapi::mkl::vm::status set_status(
        sycl::queue& exec_queue,
        oneapi::mkl::vm::status new_status);

} // namespace oneapi::mkl::vm

Description

The set_status function sets the global VM status to new value and returns the previous VM status code 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.
new_status: Specifies the VM status to be set.

Output Parameters

return value (old_status): Specifies the former VM status.

Parent topic: VM Service Functions