dnnl::error Struct Reference

DNNL exception class. More...

#include <dnnl.hpp>

Inherits exception.

Public Member Functions
	error (dnnl_status_t astatus, const char *amessage)
	Constructs an error instance. More...
const char *	what () const noexcept override
	Returns the explanatory string.

Static Public Member Functions
static void	wrap_c_api (dnnl_status_t status, const char *message)
	A convenience function for wrapping calls to the C API. More...

Detailed Description

DNNL exception class.

This class captures the status returned by the failed C API function, error message, and, optionally, handle of the primitive that caused the error.

Examples:

cnn_inference_f32.cpp, cnn_inference_int8.cpp, cnn_training_f32.cpp, cpu_cnn_training_bf16.cpp, cpu_rnn_inference_f32.cpp, cpu_rnn_inference_int8.cpp, cross_engine_reorder.cpp, getting_started.cpp, gpu_opencl_interop.cpp, memory_format_propagation.cpp, and rnn_training_f32.cpp.

Constructor & Destructor Documentation

error()

dnnl::error::error ( dnnl_status_t  astatus, const char *  amessage  )

inline

Constructs an error instance.

Parameters

astatus	The error status returned by the C API.
amessage	The error message.

Member Function Documentation

wrap_c_api()

static void dnnl::error::wrap_c_api ( dnnl_status_t  status, const char *  message  )

inlinestatic

A convenience function for wrapping calls to the C API.

Checks the return status and throws an error in case of failure.

Parameters

status	The error status returned by the C API.
message	The error message.

---

The documentation for this struct was generated from the following file:

• include/dnnl.hpp