Intel® oneAPI Deep Neural Network Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-2601D5DD-88C2-4B34-BA17-B3BA865A3086
Visible to Intel only — GUID: GUID-2601D5DD-88C2-4B34-BA17-B3BA865A3086
struct dnnl::stream
Overview
An execution stream. More…
#include <dnnl_common.hpp>
struct stream: public dnnl::handle
{
// enums
enum flags;
// construction
stream();
stream(const engine& aengine, flags aflags = flags::default_flags);
// methods
engine get_engine() const;
stream& wait();
handle();
handle();
handle();
handle();
};Inherited Members
public:
// methods
handle<T, traits>& operator = (const handle<T, traits>&);
handle<T, traits>& operator = (handle<T, traits>&&);
void reset(T t, bool weak = false);
T get(bool allow_empty = false) const;
operator T () const;
operator bool () const;
bool operator == (const handle<T, traits>& other) const;
bool operator != (const handle& other) const;Detailed Documentation
An execution stream.
Construction
stream()Constructs an empty stream.
An empty stream cannot be used in any operations.
stream(const engine& aengine, flags aflags = flags::default_flags)Constructs a stream for the specified engine and with behavior controlled by the specified flags.
Parameters:
aengine |
Engine to create the stream on. |
aflags |
Flags controlling stream behavior. |
Methods
engine get_engine() constReturns the associated engine.
stream& wait()Waits for all primitives executing in the stream to finish.
Returns:
The stream itself.
handle()Constructs an empty handle object.
handle()Copy constructor.
handle()Move constructor.
handle()Constructs a handle wrapper object from a C API handle.
Parameters:
t |
The C API handle to wrap. |
weak |
A flag specifying whether to construct a weak wrapper; defaults to false. |