Deep Neural Network Library (DNNL)  1.3.0
Performance library for Deep Learning
Public Member Functions | Static Public Member Functions | List of all members
dnnl::error Struct Reference

DNNL exception class. More...

#include <dnnl.hpp>

Inherits exception.

Public Member Functions

 error (dnnl_status_t status, const char *message)
 Constructs an instance of an exception class. 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 C API functions. More...
 

Detailed Description

DNNL exception class.

This class captures the status returned by a failed C API function and the error message from the call site.

Examples:
cnn_inference_int8.cpp, cpu_cnn_training_bf16.cpp, and getting_started.cpp.

Constructor & Destructor Documentation

◆ error()

dnnl::error::error ( dnnl_status_t  status,
const char *  message 
)
inline

Constructs an instance of an exception class.

Parameters
statusThe error status returned by a C API function.
messageThe 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 C API functions.

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

Parameters
statusThe error status returned by a C API function.
messageThe error message.

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