\doxysection{gko::\+hip\+\_\+stream Class Reference}
\hypertarget{classgko_1_1hip__stream}{}\label{classgko_1_1hip__stream}\index{gko::hip\_stream@{gko::hip\_stream}}


An RAII wrapper for a custom HIP stream.  




{\ttfamily \+\#include $<$ginkgo/\+core/\+base/\+stream.\+hpp$>$}

\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9}\label{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9} 
{\bfseries hip\+\_\+stream} ()
\begin{DoxyCompactList}\small\item\em Creates an empty stream wrapper, representing the default stream. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{classgko_1_1hip__stream_ab6adfa7a3afcfcb97ba5d7f06c085240}{hip\+\_\+stream}} (int device\+\_\+id)
\begin{DoxyCompactList}\small\item\em Creates a new custom HIP stream on the given device. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1hip__stream_ae66a34d15d251ab942af982d409a8e93}\label{classgko_1_1hip__stream_ae66a34d15d251ab942af982d409a8e93} 
{\bfseries \texorpdfstring{$\sim$}{\string~}hip\+\_\+stream} ()
\begin{DoxyCompactList}\small\item\em Destroys the custom HIP stream, if it isn\textquotesingle{}t empty. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1hip__stream_a72fcbfc2aed6390151cb2471042dba9b}\label{classgko_1_1hip__stream_a72fcbfc2aed6390151cb2471042dba9b} 
{\bfseries hip\+\_\+stream} (const hip\+\_\+stream \&)=delete
\item 
\Hypertarget{classgko_1_1hip__stream_a0b346c57d2cc9e9ee37deeaa5ac8ce60}\label{classgko_1_1hip__stream_a0b346c57d2cc9e9ee37deeaa5ac8ce60} 
{\bfseries hip\+\_\+stream} (hip\+\_\+stream \&\&)
\begin{DoxyCompactList}\small\item\em Move-\/constructs from an existing stream, which will be emptied. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1hip__stream_a1fa889e5863757aa2a896a1022b6895f}\label{classgko_1_1hip__stream_a1fa889e5863757aa2a896a1022b6895f} 
\doxymbox{\hyperlink{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9}{hip\+\_\+stream}} \& {\bfseries operator=} (const \doxymbox{\hyperlink{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9}{hip\+\_\+stream}} \&)=delete
\item 
\Hypertarget{classgko_1_1hip__stream_a0c455d59dede3c380f9acb950b10956e}\label{classgko_1_1hip__stream_a0c455d59dede3c380f9acb950b10956e} 
\doxymbox{\hyperlink{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9}{hip\+\_\+stream}} \& {\bfseries operator=} (\doxymbox{\hyperlink{classgko_1_1hip__stream_adbbf3251c2e50ae1430ebd2dcb77c0d9}{hip\+\_\+stream}} \&\&)=delete
\begin{DoxyCompactList}\small\item\em Move-\/assigns from an existing stream, which will be emptied. \end{DoxyCompactList}\item 
CUstream\+\_\+st \texorpdfstring{$\ast$}{*} \doxymbox{\hyperlink{classgko_1_1hip__stream_ac76f8c38f0ec515180441491bdd37748}{get}} () const
\begin{DoxyCompactList}\small\item\em Returns the native HIP stream handle. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
An RAII wrapper for a custom HIP stream. 

The stream will be created on construction and destroyed when the lifetime of the wrapper ends. 

\label{doc-constructors}
\Hypertarget{classgko_1_1hip__stream_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classgko_1_1hip__stream_ab6adfa7a3afcfcb97ba5d7f06c085240}\index{gko::hip\_stream@{gko::hip\_stream}!hip\_stream@{hip\_stream}}
\index{hip\_stream@{hip\_stream}!gko::hip\_stream@{gko::hip\_stream}}
\doxysubsubsection{\texorpdfstring{hip\_stream()}{hip\_stream()}}
{\footnotesize\ttfamily \label{classgko_1_1hip__stream_ab6adfa7a3afcfcb97ba5d7f06c085240} 
gko::\+hip\+\_\+stream::\+hip\+\_\+stream (\begin{DoxyParamCaption}\item[{int}]{device\+\_\+id}{}\end{DoxyParamCaption})}



Creates a new custom HIP stream on the given device. 


\begin{DoxyParams}{Parameters}
{\em device\+\_\+id} & the device ID to create the stream on. \\
\hline
\end{DoxyParams}


\label{doc-func-members}
\Hypertarget{classgko_1_1hip__stream_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1hip__stream_ac76f8c38f0ec515180441491bdd37748}\index{gko::hip\_stream@{gko::hip\_stream}!get@{get}}
\index{get@{get}!gko::hip\_stream@{gko::hip\_stream}}
\doxysubsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily \label{classgko_1_1hip__stream_ac76f8c38f0ec515180441491bdd37748} 
CUstream\+\_\+st \texorpdfstring{$\ast$}{*} gko::\+hip\+\_\+stream::\+get (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const}



Returns the native HIP stream handle. 

In an empty \doxylink{classgko_1_1hip__stream}{hip\+\_\+stream}, this will return nullptr. 

The documentation for this class was generated from the following file:\+\begin{DoxyCompactItemize}
\item 
ginkgo/\+core/\+base/\+stream.\+hpp\end{DoxyCompactItemize}
