\doxysection{gko::\+experimental::\+mpi::\+request Class Reference}
\hypertarget{classgko_1_1experimental_1_1mpi_1_1request}{}\label{classgko_1_1experimental_1_1mpi_1_1request}\index{gko::experimental::mpi::request@{gko::experimental::mpi::request}}


The request class is a light, move-\/only wrapper around the MPI\+\_\+\+Request handle.  




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

\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}{request}} ()
\begin{DoxyCompactList}\small\item\em The default constructor. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_ac10602f9074f7c692104ae921643cef5}\label{classgko_1_1experimental_1_1mpi_1_1request_ac10602f9074f7c692104ae921643cef5} 
{\bfseries request} (const request \&)=delete
\item 
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_ab112b63ae0ea8b382cdebec34201577d}\label{classgko_1_1experimental_1_1mpi_1_1request_ab112b63ae0ea8b382cdebec34201577d} 
\doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}{request}} \& {\bfseries operator=} (const \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}{request}} \&)=delete
\item 
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_a6c7107f1ab707b7bc4fe0309f48cba75}\label{classgko_1_1experimental_1_1mpi_1_1request_a6c7107f1ab707b7bc4fe0309f48cba75} 
{\bfseries request} (request \&\&o) noexcept
\item 
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_a36a814673cc7f52512f55d84c9da2f95}\label{classgko_1_1experimental_1_1mpi_1_1request_a36a814673cc7f52512f55d84c9da2f95} 
\doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}{request}} \& {\bfseries operator=} (\doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}{request}} \&\&o) noexcept
\item 
MPI\+\_\+\+Request \texorpdfstring{$\ast$}{*} \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_a9b4b79bdb828944badb7f342511b245b}{get}} ()
\begin{DoxyCompactList}\small\item\em Get a pointer to the underlying MPI\+\_\+\+Request handle. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{structgko_1_1experimental_1_1mpi_1_1status}{status}} \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1request_aaddf632d971062a584b0aea23a393381}{wait}} ()
\begin{DoxyCompactList}\small\item\em Allows a rank to wait on a particular request handle. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The request class is a light, move-\/only wrapper around the MPI\+\_\+\+Request handle. 

\label{doc-constructors}
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d}\index{gko::experimental::mpi::request@{gko::experimental::mpi::request}!request@{request}}
\index{request@{request}!gko::experimental::mpi::request@{gko::experimental::mpi::request}}
\doxysubsubsection{\texorpdfstring{request()}{request()}}
{\footnotesize\ttfamily \label{classgko_1_1experimental_1_1mpi_1_1request_a134558fdd79e32441a9854fa19630f3d} 
gko::\+experimental::\+mpi::\+request::\+request (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



The default constructor. 

It creates a null MPI\+\_\+\+Request of MPI\+\_\+\+REQUEST\+\_\+\+NULL type. 

\label{doc-func-members}
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_a9b4b79bdb828944badb7f342511b245b}\index{gko::experimental::mpi::request@{gko::experimental::mpi::request}!get@{get}}
\index{get@{get}!gko::experimental::mpi::request@{gko::experimental::mpi::request}}
\doxysubsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily \label{classgko_1_1experimental_1_1mpi_1_1request_a9b4b79bdb828944badb7f342511b245b} 
MPI\+\_\+\+Request \texorpdfstring{$\ast$}{*} gko::\+experimental::\+mpi::\+request::\+get (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Get a pointer to the underlying MPI\+\_\+\+Request handle. 

\begin{DoxyReturn}{Returns}
a pointer to MPI\+\_\+\+Request handle 
\end{DoxyReturn}


Referenced by \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_ab72560fb614cb0d16cd5c52048e98360}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+gather()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_acefa109840bc98d51a826dbd40d235db}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+reduce()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a7d28b094fb7f08bc9c52fffd0180abc0}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+reduce()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a3dd5f4399b6f740663abfd606a24bf08}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+to\+\_\+all()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a7e1b0265baa6fd66a820451f8469d360}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+to\+\_\+all()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a4096892bc72d3302bf6fcb3e8362744c}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+all\+\_\+to\+\_\+all\+\_\+v()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a0edf57701938af05bb356f1228798ad8}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+broadcast()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a74aeeeb289a7509c1669b156fbf3637a}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+gather()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_acc0eaaa2c5ae836eb28903e17add1a8a}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+gather\+\_\+v()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a2ea79fc26a548eb7d42b8e54d877c3aa}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+recv()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a5d4ff6a0c4d5af67292a22561d7f58e5}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+reduce()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_ad7b0f3302cff2314ade8d3fd9468eb0c}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+scan()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_af0b769c1f173f9808503fd76ea980c73}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+scatter()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_a340726b3a0f1f3ec176ea68dbb4b30fa}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+scatter\+\_\+v()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1communicator_af6265023d1c4f4965b71c309198f608b}{gko::\+experimental::\+mpi::\+communicator::\+i\+\_\+send()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1window_a4fc76b03f10fe40c84c4b5d123f453b9}{gko::\+experimental::\+mpi::\+window$<$ Value\+Type $>$::\+r\+\_\+accumulate()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1window_af611adbe29e925ef5448ead49bde179e}{gko::\+experimental::\+mpi::\+window$<$ Value\+Type $>$::\+r\+\_\+get()}}, \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1window_a69842676f3a38849160857138ce0b745}{gko::\+experimental::\+mpi::\+window$<$ Value\+Type $>$::\+r\+\_\+get\+\_\+accumulate()}}, and \doxymbox{\hyperlink{classgko_1_1experimental_1_1mpi_1_1window_a08ddae163fc1c34b9456bab96a5f1107}{gko::\+experimental::\+mpi::\+window$<$ Value\+Type $>$::\+r\+\_\+put()}}.

\Hypertarget{classgko_1_1experimental_1_1mpi_1_1request_aaddf632d971062a584b0aea23a393381}\index{gko::experimental::mpi::request@{gko::experimental::mpi::request}!wait@{wait}}
\index{wait@{wait}!gko::experimental::mpi::request@{gko::experimental::mpi::request}}
\doxysubsubsection{\texorpdfstring{wait()}{wait()}}
{\footnotesize\ttfamily \label{classgko_1_1experimental_1_1mpi_1_1request_aaddf632d971062a584b0aea23a393381} 
\doxymbox{\hyperlink{structgko_1_1experimental_1_1mpi_1_1status}{status}} gko::\+experimental::\+mpi::\+request::\+wait (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Allows a rank to wait on a particular request handle. 


\begin{DoxyParams}{Parameters}
{\em req} & The request to wait on. \\
\hline
{\em \doxylink{structgko_1_1experimental_1_1mpi_1_1status}{status}} & The status variable that can be queried. \\
\hline
\end{DoxyParams}


References \doxymbox{\hyperlink{structgko_1_1experimental_1_1mpi_1_1status_afe7e18a49071abb74093b2da1ceda96f}{gko::\+experimental::\+mpi::\+status::\+get()}}.



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