oneAPI Deep Neural Network Library (oneDNN)  1.4.0
Performance library for Deep Learning
Loading...
Searching...
No Matches
dnnl::stream_attr Struct Reference

A container for stream attributes. More...

#include <dnnl.hpp>

Inheritance diagram for dnnl::stream_attr:
Collaboration diagram for dnnl::stream_attr:

Public Member Functions

 stream_attr ()=default
 Constructs default (empty) stream attributes.
 stream_attr (engine::kind kind)
 Constructs stream attributes for a stream that runs on an engine of a particular kind.
 handle ()=default
 Constructs an empty handle object.
 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.
Public Member Functions inherited from dnnl::handle< dnnl_stream_attr_t >
 handle ()=default
 Constructs an empty handle object.
handle< dnnl_stream_attr_t, handle_traits< dnnl_stream_attr_t > > & operator= (const handle< dnnl_stream_attr_t, handle_traits< dnnl_stream_attr_t > > &)=default
 Assignment operator.
void reset (dnnl_stream_attr_t t, bool weak=false)
 Resets the handle wrapper objects to wrap a new C API handle.
dnnl_stream_attr_t get (bool allow_empty=false) const
 Returns the underlying C API handle.
 operator dnnl_stream_attr_t () const
 Converts a handle to the underlying C API handle type.
 operator bool () const
 Checks whether the object is empty.

Detailed Description

A container for stream attributes.

Constructor & Destructor Documentation

◆ stream_attr()

dnnl::stream_attr::stream_attr ( engine::kind kind)
inline

Constructs stream attributes for a stream that runs on an engine of a particular kind.

Parameters
kindTarget engine kind.

Member Function Documentation

◆ handle() [1/2]

dnnl::handle< T, traits >::handle ( )
default

Constructs an empty handle object.

Warning
Uninitialized object cannot be used in most library calls and is equivalent to a null pointer. Any attempt to use its methods, or passing it to the other library function, will cause an exception to be thrown.

◆ handle() [2/2]

dnnl::handle< T, traits >::handle ( T t,
bool weak = false )
inlineexplicit

Constructs a handle wrapper object from a C API handle.

Parameters
tThe C API handle to wrap.
weakA flag specifying whether to construct a weak wrapper; defaults to false.

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