\doxysection{gko::\+batch\+\_\+dim\texorpdfstring{$<$}{<} Dimensionality, Dimension\+Type \texorpdfstring{$>$}{>} Struct Template Reference}
\hypertarget{structgko_1_1batch__dim}{}\label{structgko_1_1batch__dim}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}


A type representing the dimensions of a multidimensional batch object.  




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



Inheritance diagram for gko::\+batch\+\_\+dim\texorpdfstring{$<$}{<} Dimensionality, Dimension\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=238pt]{structgko_1_1batch__dim__inherit__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1batch__dim_a8365c267773089cbfb1c5a49f0392a6f}\label{structgko_1_1batch__dim_a8365c267773089cbfb1c5a49f0392a6f} 
using {\bfseries dimension\+\_\+type} = Dimension\+Type
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} \doxymbox{\hyperlink{structgko_1_1batch__dim_a380f449cd6305c8baba95569627503b2}{get\+\_\+num\+\_\+batch\+\_\+items}} () const
\begin{DoxyCompactList}\small\item\em Get the number of batch items stored. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{structgko_1_1dim}{dim}}$<$ dimensionality, dimension\+\_\+type $>$ \doxymbox{\hyperlink{structgko_1_1batch__dim_a2e5b548457e59a551328cb10cc38a688}{get\+\_\+common\+\_\+size}} () const
\begin{DoxyCompactList}\small\item\em Get the common size of the batch items. \end{DoxyCompactList}\item 
\Hypertarget{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}\label{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc} 
{\bfseries batch\+\_\+dim} ()
\begin{DoxyCompactList}\small\item\em The default constructor. \end{DoxyCompactList}\item 
\doxymbox{\hyperlink{structgko_1_1batch__dim_a084efe247f49ff54a4156858991a2eb5}{batch\+\_\+dim}} (const \doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} num\+\_\+batch\+\_\+items, const \doxymbox{\hyperlink{structgko_1_1dim}{dim}}$<$ dimensionality, dimension\+\_\+type $>$ \&common\+\_\+size)
\begin{DoxyCompactList}\small\item\em Creates a \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} object which stores a uniform size for all batch entries. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{structgko_1_1batch__dim_a89d3003b0dd42878ab517294b397524c}\label{structgko_1_1batch__dim_a89d3003b0dd42878ab517294b397524c} 
static constexpr \doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} {\bfseries dimensionality} = Dimensionality
\end{DoxyCompactItemize}
\doxysubsubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
bool \doxymbox{\hyperlink{structgko_1_1batch__dim_a8ab2005862218bbbe2bb1e35868b0ad0}{operator==}} (const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}} \&x, const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}} \&y)
\begin{DoxyCompactList}\small\item\em Checks if two \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} objects are equal. \end{DoxyCompactList}\item 
bool \doxymbox{\hyperlink{structgko_1_1batch__dim_a1f2d93006b55ad3002e7074e3e6035ee}{operator!=}} (const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&x, const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&y)
\begin{DoxyCompactList}\small\item\em Checks if two \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} objects are different. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$\newline
struct gko::\+batch\+\_\+dim$<$ Dimensionality, Dimension\+Type $>$}
A type representing the dimensions of a multidimensional batch object. 


\begin{DoxyTemplParams}{Template Parameters}
{\em Dimensionality} & number of dimensions of the object \\
\hline
{\em Dimension\+Type} & datatype used to represent each dimension \\
\hline
\end{DoxyTemplParams}


\label{doc-constructors}
\Hypertarget{structgko_1_1batch__dim_doc-constructors}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{structgko_1_1batch__dim_a084efe247f49ff54a4156858991a2eb5}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}!batch\_dim@{batch\_dim}}
\index{batch\_dim@{batch\_dim}!gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}
\doxysubsubsection{\texorpdfstring{batch\_dim()}{batch\_dim()}}
{\footnotesize\ttfamily \label{structgko_1_1batch__dim_a084efe247f49ff54a4156858991a2eb5} 
template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$ \\
\doxymbox{\hyperlink{structgko_1_1batch__dim}{gko::\+batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$::\+batch\+\_\+dim (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}}}]{num\+\_\+batch\+\_\+items}{, }\item[{const \doxymbox{\hyperlink{structgko_1_1dim}{dim}}$<$ dimensionality, dimension\+\_\+type $>$ \&}]{common\+\_\+size}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}}



Creates a \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} object which stores a uniform size for all batch entries. 


\begin{DoxyParams}{Parameters}
{\em num\+\_\+batch\+\_\+items} & the number of batch items to be stored \\
\hline
{\em common\+\_\+size} & the common size of all the batch items stored\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Use this constructor when uniform batches need to be stored. 
\end{DoxyNote}


\label{doc-func-members}
\Hypertarget{structgko_1_1batch__dim_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{structgko_1_1batch__dim_a2e5b548457e59a551328cb10cc38a688}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}!get\_common\_size@{get\_common\_size}}
\index{get\_common\_size@{get\_common\_size}!gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}
\doxysubsubsection{\texorpdfstring{get\_common\_size()}{get\_common\_size()}}
{\footnotesize\ttfamily \label{structgko_1_1batch__dim_a2e5b548457e59a551328cb10cc38a688} 
template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$ \\
\doxymbox{\hyperlink{structgko_1_1dim}{dim}}$<$ dimensionality, dimension\+\_\+type $>$ \doxymbox{\hyperlink{structgko_1_1batch__dim}{gko::\+batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$::\+get\+\_\+common\+\_\+size (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the common size of the batch items. 

\begin{DoxyReturn}{Returns}
common\+\_\+size 
\end{DoxyReturn}


Referenced by \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp_ab50d8aefbcebd8dcb9b6a97ab131d59d}{gko::\+batch::\+\+Batch\+Lin\+Op::\+get\+\_\+common\+\_\+size()}}, and \doxymbox{\hyperlink{namespacegko_aacad7f87b38d3f26674ed034d442a1a0}{gko::\+transpose()}}.

\Hypertarget{structgko_1_1batch__dim_a380f449cd6305c8baba95569627503b2}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}!get\_num\_batch\_items@{get\_num\_batch\_items}}
\index{get\_num\_batch\_items@{get\_num\_batch\_items}!gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}
\doxysubsubsection{\texorpdfstring{get\_num\_batch\_items()}{get\_num\_batch\_items()}}
{\footnotesize\ttfamily \label{structgko_1_1batch__dim_a380f449cd6305c8baba95569627503b2} 
template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$ \\
\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} \doxymbox{\hyperlink{structgko_1_1batch__dim}{gko::\+batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$::\+get\+\_\+num\+\_\+batch\+\_\+items (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the number of batch items stored. 

\begin{DoxyReturn}{Returns}
num\+\_\+batch\+\_\+items 
\end{DoxyReturn}


Referenced by \doxymbox{\hyperlink{classgko_1_1batch_1_1BatchLinOp_aedce5278a6da01435e69cd4b12782375}{gko::\+batch::\+\+Batch\+Lin\+Op::\+get\+\_\+num\+\_\+batch\+\_\+items()}}, and \doxymbox{\hyperlink{namespacegko_aacad7f87b38d3f26674ed034d442a1a0}{gko::\+transpose()}}.



\label{doc-related-members}
\Hypertarget{structgko_1_1batch__dim_doc-related-members}
\doxysubsection{Friends And Related Symbol Documentation}
\Hypertarget{structgko_1_1batch__dim_a1f2d93006b55ad3002e7074e3e6035ee}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}
\doxysubsubsection{\texorpdfstring{operator"!=}{operator!=}}
{\footnotesize\ttfamily \label{structgko_1_1batch__dim_a1f2d93006b55ad3002e7074e3e6035ee} 
template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$ \\
bool operator!= (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&}]{x}{, }\item[{const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&}]{y}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}



Checks if two \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} objects are different. 


\begin{DoxyTemplParams}{Template Parameters}
{\em Dimensionality} & number of dimensions of the dim objects \\
\hline
{\em Dimension\+Type} & datatype used to represent each dimension\\
\hline
\end{DoxyTemplParams}

\begin{DoxyParams}{Parameters}
{\em x} & first object \\
\hline
{\em y} & second object\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily !(x == y)} 
\end{DoxyReturn}


References \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim()}}.

\Hypertarget{structgko_1_1batch__dim_a8ab2005862218bbbe2bb1e35868b0ad0}\index{gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}!operator==@{operator==}}
\index{operator==@{operator==}!gko::batch\_dim$<$ Dimensionality, DimensionType $>$@{gko::batch\_dim$<$ Dimensionality, DimensionType $>$}}
\doxysubsubsection{\texorpdfstring{operator==}{operator==}}
{\footnotesize\ttfamily \label{structgko_1_1batch__dim_a8ab2005862218bbbe2bb1e35868b0ad0} 
template$<$\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} Dimensionality = 2, typename Dimension\+Type = size\+\_\+type$>$ \\
bool operator== (\begin{DoxyParamCaption}\item[{const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&}]{x}{, }\item[{const \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim}}$<$ Dimensionality, Dimension\+Type $>$ \&}]{y}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}



Checks if two \doxylink{structgko_1_1batch__dim}{batch\+\_\+dim} objects are equal. 


\begin{DoxyParams}{Parameters}
{\em x} & first object \\
\hline
{\em y} & second object\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if and only if all dimensions of both objects are equal. 
\end{DoxyReturn}


References \doxymbox{\hyperlink{structgko_1_1batch__dim_a9ad0e2ce59184e0969c4cfbbccd16fbc}{batch\+\_\+dim()}}.



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