clear_status#

Resets the global VM status to oneapi::math::vm::status::success and returns the previous VM status code.

Syntax

namespace oneapi::math::vm {

    oneapi::math::vm::status clear_status(
        sycl::queue& exec_queue);

} // namespace oneapi::math::vm

Description

The clear_status function sets the VM status code to oneapi::math::vm::status::success 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 code	Description
Successful Execution
`oneapi::math::vm::status::success`	VM function execution completed successfully
`oneapi::math::vm::status::not_defined`	VM status not defined
Warnings
`oneapi::math::vm::status::accuracy_warning`	VM function execution completed successfully in a different accuracy mode
Computational status codes
`oneapi::math::vm::status::errdom`	Values are out of a range of definition producing invalid (QNaN) result
`oneapi::math::vm::status::sing`	Values cause divide-by-zero (singularity) computational errors and produce and invalid (QNaN or Inf) result
`oneapi::math::vm::status::overflow`	An overflow happened during the calculation process
`oneapi::math::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 (old_status): Specifies the VM status code before the call.

Parent topic: VM Service Functions