oneAPI Deep Neural Network Library (oneDNN)
Performance library for Deep Learning
1.96.0
dnnl::matmul Struct Reference

Matrix multiplication (matmul) primitive. More...

#include <dnnl.hpp>

Inheritance diagram for dnnl::matmul:
Collaboration diagram for dnnl::matmul:

Classes

struct  desc
 Descriptor for a matmul primitive. More...
 
struct  primitive_desc
 Primitive descriptor for a matmul primitive. More...
 

Public Member Functions

 matmul ()=default
 Default constructor. Produces an empty object.
 
 matmul (const primitive_desc &pd)
 Constructs a matmul primitive. More...
 
- Public Member Functions inherited from dnnl::primitive
 primitive ()=default
 Default constructor. Constructs an empty object.
 
 primitive (const_dnnl_primitive_desc_t c_pd)
 Constructs a primitive from a C API primitive descriptor. More...
 
 primitive (const primitive_desc &pd)
 Constructs a primitive from a primitive descriptor. More...
 
const_dnnl_primitive_desc_t get_primitive_desc () const
 Returns the C API primitive descriptor of the underlying C API primitive. More...
 
kind get_kind () const
 Returns the kind of the primitive. More...
 
void execute (const stream &astream, const std::unordered_map< int, memory > &args) const
 Executes computations specified by the primitive in a specified stream. More...
 
 handle ()=default
 Constructs an empty handle object. More...
 
 handle (const handle< T, traits > &)=default
 Copy constructor.
 
 handle (handle< T, traits > &&)=default
 Move constructor.
 
 handle (T t, bool weak=false)
 Constructs a handle wrapper object from a C API handle. More...
 
- Public Member Functions inherited from dnnl::handle< dnnl_primitive_t >
bool operator== (const handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > &other) const
 Equality operator. More...
 
bool operator!= (const handle &other) const
 Inequality operator. More...
 
 handle ()=default
 Constructs an empty handle object. More...
 
 handle (const handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > &)=default
 Copy constructor.
 
 handle (handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > &&)=default
 Move constructor.
 
 handle (dnnl_primitive_t t, bool weak=false)
 Constructs a handle wrapper object from a C API handle. More...
 
handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > & operator= (const handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > &)=default
 Assignment operator.
 
handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > & operator= (handle< dnnl_primitive_t, handle_traits< dnnl_primitive_t > > &&)=default
 Move assignment operator.
 
void reset (dnnl_primitive_t t, bool weak=false)
 Resets the handle wrapper objects to wrap a new C API handle. More...
 
dnnl_primitive_t get (bool allow_empty=false) const
 Returns the underlying C API handle. More...
 
 operator dnnl_primitive_t () const
 Converts a handle to the underlying C API handle type. More...
 
 operator bool () const
 Checks whether the object is not empty. More...
 

Additional Inherited Members

- Public Types inherited from dnnl::primitive
enum  kind
 Kinds of primitives supported by the library. More...
 

Detailed Description

Matrix multiplication (matmul) primitive.

Examples:
cpu_matmul_quantization.cpp, cpu_sgemm_and_matmul.cpp, inference_int8_matmul.cpp, and matmul.cpp.

Constructor & Destructor Documentation

◆ matmul()

dnnl::matmul::matmul ( const primitive_desc pd)
inline

Constructs a matmul primitive.

Parameters
pdPrimitive descriptor for a matmul primitive.

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