Intel(R) Math Kernel Library for Deep Neural Networks (Intel(R) MKL-DNN)  0.10
Performance library for Deep Learning
Functions

A primitive to describe data. More...

Functions

mkldnn_status_t MKLDNN_API mkldnn_memory_desc_init (mkldnn_memory_desc_t *memory_desc, int ndims, const mkldnn_dims_t dims, mkldnn_data_type_t data_type, mkldnn_memory_format_t format)
 Initializes a memory_desc memory descriptor using ndims, dims, data_type, and data format. More...
 
mkldnn_status_t MKLDNN_API mkldnn_memory_primitive_desc_create (mkldnn_primitive_desc_t *memory_primitive_desc, const mkldnn_memory_desc_t *memory_desc, mkldnn_engine_t engine)
 Creates a memory_primitive_desc memory primitive descriptor using memory_desc and engine. More...
 
mkldnn_status_t MKLDNN_API mkldnn_view_primitive_desc_create (mkldnn_primitive_desc_t *view_primitive_desc, const_mkldnn_primitive_desc_t memory_primitive_desc, const mkldnn_dims_t dims, const mkldnn_dims_t offsets)
 Creates a view_primitive_desc for a given memory_primitive_desc, with dims sizes and offset offsets. More...
 
int MKLDNN_API mkldnn_memory_primitive_desc_equal (const_mkldnn_primitive_desc_t lhs, const_mkldnn_primitive_desc_t rhs)
 Compares two descriptors of memory primitives. More...
 
size_t MKLDNN_API mkldnn_memory_primitive_desc_get_size (const_mkldnn_primitive_desc_t memory_primitive_desc)
 Returns the size (in bytes) that is required for given memory_primitive_desc. More...
 
mkldnn_status_t MKLDNN_API mkldnn_memory_get_data_handle (const_mkldnn_primitive_t memory, void **handle)
 For a memory primitive, returns the data handle. More...
 
mkldnn_status_t MKLDNN_API mkldnn_memory_set_data_handle (mkldnn_primitive_t memory, void *handle)
 For a memory primitive, sets the data handle. More...
 

Detailed Description

A primitive to describe data.

Function Documentation

◆ mkldnn_memory_desc_init()

mkldnn_status_t MKLDNN_API mkldnn_memory_desc_init ( mkldnn_memory_desc_t memory_desc,
int  ndims,
const mkldnn_dims_t  dims,
mkldnn_data_type_t  data_type,
mkldnn_memory_format_t  format 
)

Initializes a memory_desc memory descriptor using ndims, dims, data_type, and data format.

format can be mkldnn_any, which means that specific data layouts are not permitted.

◆ mkldnn_memory_get_data_handle()

mkldnn_status_t MKLDNN_API mkldnn_memory_get_data_handle ( const_mkldnn_primitive_t  memory,
void **  handle 
)

For a memory primitive, returns the data handle.

For the CPU engine, the data handle is a pointer to the actual data.

◆ mkldnn_memory_primitive_desc_create()

mkldnn_status_t MKLDNN_API mkldnn_memory_primitive_desc_create ( mkldnn_primitive_desc_t memory_primitive_desc,
const mkldnn_memory_desc_t memory_desc,
mkldnn_engine_t  engine 
)

Creates a memory_primitive_desc memory primitive descriptor using memory_desc and engine.

memory_desc cannot be uncertain, that is, initialized with mkldnn_any.

◆ mkldnn_memory_primitive_desc_equal()

int MKLDNN_API mkldnn_memory_primitive_desc_equal ( const_mkldnn_primitive_desc_t  lhs,
const_mkldnn_primitive_desc_t  rhs 
)

Compares two descriptors of memory primitives.

Returns
1 if the descriptors are the same.
0 if the descriptors are different.

Use this function to identify whether a reorder is required for the memory primitives. lhs and rhs must be either memory or view primitive descriptors.

◆ mkldnn_memory_primitive_desc_get_size()

size_t MKLDNN_API mkldnn_memory_primitive_desc_get_size ( const_mkldnn_primitive_desc_t  memory_primitive_desc)

Returns the size (in bytes) that is required for given memory_primitive_desc.

◆ mkldnn_memory_set_data_handle()

mkldnn_status_t MKLDNN_API mkldnn_memory_set_data_handle ( mkldnn_primitive_t  memory,
void *  handle 
)

For a memory primitive, sets the data handle.

◆ mkldnn_view_primitive_desc_create()

mkldnn_status_t MKLDNN_API mkldnn_view_primitive_desc_create ( mkldnn_primitive_desc_t view_primitive_desc,
const_mkldnn_primitive_desc_t  memory_primitive_desc,
const mkldnn_dims_t  dims,
const mkldnn_dims_t  offsets 
)

Creates a view_primitive_desc for a given memory_primitive_desc, with dims sizes and offset offsets.

May fail if layout used does not allow obtain desired view. In this case consider using extract primitive