struct dnnl::error

Overview

oneDNN exception class. More…

#include <dnnl.hpp>

struct error: public exception
{
    // fields

    dnnl_status_t status;
    const char* message;

    // methods

    error(dnnl_status_t status, const char* message);
    const char* what() const;
    static void wrap_c_api(dnnl_status_t status, const char* message);
};

Detailed Documentation

oneDNN exception class.

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

Methods

error(dnnl_status_t status, const char* message)

Constructs an instance of an exception class.

Parameters:

status

The error status returned by a C API function.

message

The error message.

const char* what() const

Returns the explanatory string.

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

A convenience function for wrapping calls to C API functions.

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

Parameters:

status

The error status returned by a C API function.

message

The error message.