\hypertarget{classnntrainer_1_1Sample}{}\doxysection{nntrainer\+::Sample Class Reference}
\label{classnntrainer_1_1Sample}\index{nntrainer::Sample@{nntrainer::Sample}}


\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} class which views the memory for a single sample.  




{\ttfamily \#include $<$data\+\_\+iteration.\+h$>$}

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classnntrainer_1_1Sample_a0f1766a234f1320c401ff207a1c8d666}{Sample}} (const \mbox{\hyperlink{classnntrainer_1_1Iteration}{Iteration}} \&iter, unsigned int batch)
\begin{DoxyCompactList}\small\item\em Construct a new \mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} object. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classnntrainer_1_1Sample_a07893e1f1e09e04c67c802ea8d501319}\label{classnntrainer_1_1Sample_a07893e1f1e09e04c67c802ea8d501319}} 
{\bfseries Sample} (const \mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \&rhs)=delete
\item 
\mbox{\Hypertarget{classnntrainer_1_1Sample_a49d3b30fe9fb843e326036e8342c02fd}\label{classnntrainer_1_1Sample_a49d3b30fe9fb843e326036e8342c02fd}} 
\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \& {\bfseries operator=} (const \mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \&rhs)=delete
\item 
\mbox{\Hypertarget{classnntrainer_1_1Sample_a0708ba27e9eaf17083c96111051448cc}\label{classnntrainer_1_1Sample_a0708ba27e9eaf17083c96111051448cc}} 
{\bfseries Sample} (\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \&\&rhs)=default
\item 
\mbox{\Hypertarget{classnntrainer_1_1Sample_aa345c45b5e4b414d7ea557bf6437e44e}\label{classnntrainer_1_1Sample_aa345c45b5e4b414d7ea557bf6437e44e}} 
\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \& {\bfseries operator=} (\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} \&\&rhs)=default
\item 
std\+::vector$<$ Tensor $>$ \& \mbox{\hyperlink{classnntrainer_1_1Sample_a323ed6fbbf9d210d5b7a16b843fa517e}{get\+Inputs\+Ref}} ()
\begin{DoxyCompactList}\small\item\em Get the Input Reference object. \end{DoxyCompactList}\item 
const std\+::vector$<$ Tensor $>$ \& \mbox{\hyperlink{classnntrainer_1_1Sample_aa39a4294dcb0696f42b5aa38144879c8}{get\+Inputs\+Ref}} () const
\begin{DoxyCompactList}\small\item\em Get the Input Reference object. \end{DoxyCompactList}\item 
std\+::vector$<$ Tensor $>$ \& \mbox{\hyperlink{classnntrainer_1_1Sample_a7db786b0e3a26f7c3508355eaf939533}{get\+Labels\+Ref}} ()
\begin{DoxyCompactList}\small\item\em Get the Label Reference object. \end{DoxyCompactList}\item 
const std\+::vector$<$ Tensor $>$ \& \mbox{\hyperlink{classnntrainer_1_1Sample_a14f3e3109cfde822e723d66c7d109d1f}{get\+Labels\+Ref}} () const
\begin{DoxyCompactList}\small\item\em Get the Label Reference object. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} class which views the memory for a single sample. 



Definition at line 137 of file data\+\_\+iteration.\+h.



\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classnntrainer_1_1Sample_a0f1766a234f1320c401ff207a1c8d666}\label{classnntrainer_1_1Sample_a0f1766a234f1320c401ff207a1c8d666}} 
\index{nntrainer::Sample@{nntrainer::Sample}!Sample@{Sample}}
\index{Sample@{Sample}!nntrainer::Sample@{nntrainer::Sample}}
\doxysubsubsection{\texorpdfstring{Sample()}{Sample()}}
{\footnotesize\ttfamily nntrainer\+::\+Sample\+::\+Sample (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classnntrainer_1_1Iteration}{Iteration}} \&}]{iter,  }\item[{unsigned int}]{batch }\end{DoxyParamCaption})}



Construct a new \mbox{\hyperlink{classnntrainer_1_1Sample}{Sample}} object. 

\begin{DoxyNote}{Note}
the batch dimension will be ignored to make a single sample
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em iter} & iteration obejcts \\
\hline
{\em batch} & nth batch to create the sample \\
\hline
\end{DoxyParams}


Definition at line 96 of file data\+\_\+iteration.\+cpp.



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classnntrainer_1_1Sample_a323ed6fbbf9d210d5b7a16b843fa517e}\label{classnntrainer_1_1Sample_a323ed6fbbf9d210d5b7a16b843fa517e}} 
\index{nntrainer::Sample@{nntrainer::Sample}!getInputsRef@{getInputsRef}}
\index{getInputsRef@{getInputsRef}!nntrainer::Sample@{nntrainer::Sample}}
\doxysubsubsection{\texorpdfstring{getInputsRef()}{getInputsRef()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily std\+::vector$<$Tensor$>$\& nntrainer\+::\+Sample\+::get\+Inputs\+Ref (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Get the Input Reference object. 

\begin{DoxyReturn}{Returns}
std\+::vector$<$\+Tensor$>$\& input 
\end{DoxyReturn}


Definition at line 159 of file data\+\_\+iteration.\+h.

\mbox{\Hypertarget{classnntrainer_1_1Sample_aa39a4294dcb0696f42b5aa38144879c8}\label{classnntrainer_1_1Sample_aa39a4294dcb0696f42b5aa38144879c8}} 
\index{nntrainer::Sample@{nntrainer::Sample}!getInputsRef@{getInputsRef}}
\index{getInputsRef@{getInputsRef}!nntrainer::Sample@{nntrainer::Sample}}
\doxysubsubsection{\texorpdfstring{getInputsRef()}{getInputsRef()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const std\+::vector$<$Tensor$>$\& nntrainer\+::\+Sample\+::get\+Inputs\+Ref (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the Input Reference object. 

\begin{DoxyReturn}{Returns}
const std\+::vector$<$\+Tensor$>$\& input 
\end{DoxyReturn}


Definition at line 166 of file data\+\_\+iteration.\+h.

\mbox{\Hypertarget{classnntrainer_1_1Sample_a7db786b0e3a26f7c3508355eaf939533}\label{classnntrainer_1_1Sample_a7db786b0e3a26f7c3508355eaf939533}} 
\index{nntrainer::Sample@{nntrainer::Sample}!getLabelsRef@{getLabelsRef}}
\index{getLabelsRef@{getLabelsRef}!nntrainer::Sample@{nntrainer::Sample}}
\doxysubsubsection{\texorpdfstring{getLabelsRef()}{getLabelsRef()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily std\+::vector$<$Tensor$>$\& nntrainer\+::\+Sample\+::get\+Labels\+Ref (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Get the Label Reference object. 

\begin{DoxyReturn}{Returns}
std\+::vector$<$\+Tensor$>$\& label 
\end{DoxyReturn}


Definition at line 173 of file data\+\_\+iteration.\+h.

\mbox{\Hypertarget{classnntrainer_1_1Sample_a14f3e3109cfde822e723d66c7d109d1f}\label{classnntrainer_1_1Sample_a14f3e3109cfde822e723d66c7d109d1f}} 
\index{nntrainer::Sample@{nntrainer::Sample}!getLabelsRef@{getLabelsRef}}
\index{getLabelsRef@{getLabelsRef}!nntrainer::Sample@{nntrainer::Sample}}
\doxysubsubsection{\texorpdfstring{getLabelsRef()}{getLabelsRef()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const std\+::vector$<$Tensor$>$\& nntrainer\+::\+Sample\+::get\+Labels\+Ref (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the Label Reference object. 

\begin{DoxyReturn}{Returns}
const std\+::vector$<$\+Tensor$>$\& label 
\end{DoxyReturn}


Definition at line 180 of file data\+\_\+iteration.\+h.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
dataset/\mbox{\hyperlink{data__iteration_8h}{data\+\_\+iteration.\+h}}\item 
dataset/\mbox{\hyperlink{data__iteration_8cpp}{data\+\_\+iteration.\+cpp}}\end{DoxyCompactItemize}
