org.bytedeco.dnnl

Class error

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.dnnl.error

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dnnl")
 @NoOffset
 @Properties(inherit=dnnl.class)
public class error
extends Pointer

\addtogroup dnnl_api_utils Utilities Utility types and definitions. \{

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

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
error(int status, BytePointer message) Constructs an instance of an exception class.
error(int status, String message)
error(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
BytePointer	message()
error	message(BytePointer setter)
int	status()
error	status(int setter)
BytePointer	toStdString()
BytePointer	what() Returns the explanatory string.
static void	wrap_c_api(int status, BytePointer message) A convenience function for wrapping calls to C API functions.
static void	wrap_c_api(int status, String message)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

error

public error(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

error

public error(@Cast(value="dnnl_status_t")
             int status,
             @Cast(value="const char*")
             BytePointer message)

Constructs an instance of an exception class.

Parameters:

status - The error status returned by a C API function.

message - The error message.

error

public error(@Cast(value="dnnl_status_t")
             int status,
             String message)

Method Detail

status

@Cast(value="dnnl_status_t")
public int status()

status

public error status(int setter)

message

@Cast(value="const char*")
public BytePointer message()

message

public error message(BytePointer setter)

what

@NoException
 @Cast(value="const char*")
public BytePointer what()

Returns the explanatory string.

wrap_c_api

public static void wrap_c_api(@Cast(value="dnnl_status_t")
                              int status,
                              @Cast(value="const char*")
                              BytePointer 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.

wrap_c_api

public static void wrap_c_api(@Cast(value="dnnl_status_t")
                              int status,
                              String message)

toStdString

@StdString
public BytePointer toStdString()