clear_status
Sets the VM Status according to
status::success
and returns the
previous VM Status.Description
The
clear_status
function sets the VM status to status::success
and returns the previous VM status.The global VM Status is a single value and it accumulates all errors
that happen inside VM functions. The following table lists the
possible error values.
Status | Description |
|---|---|
Successful Execution | |
status::success | VM function execution completed successfully |
status::not_defined | VM status not defined |
Warnings | |
status::accuracy_warning | VM function execution completed successfully in a different accuracy mode |
Computational Errors | |
status::errdom | Values are out of a range of definition producing invalid (QNaN) result |
status::sing | Values cause divide-by-zero (singularity) errors and produce and invalid (QNaN or Inf) result |
status::overflow | An overflow happened during the calculation process |
status::underflow | An underflow happened during the calculation process |
API
Syntax
namespace oneapi::mkl::vm {
uint8_t clear_status
(queue& exec_queue )
}clear_status supports the following devices: Host, CPU, and GPU.
Input Parameters
- exec_queue
- The queue where the routine should be executed.
Output Parameters
- return value (old_status)
- Specifies the former VM status.
Examples
uint8_t olderr = clear_status (exec_queue);