deep_network/doc/latex/class_layer_1_1_pooling.tex

\hypertarget{class_layer_1_1_pooling}{}\doxysection{Layer\+::Pooling Class Reference}
\label{class_layer_1_1_pooling}\index{Layer::Pooling@{Layer::Pooling}}


{\ttfamily \#include $<$pooling.\+hpp$>$}



Inheritance diagram for Layer\+::Pooling\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=166pt]{class_layer_1_1_pooling__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_layer_1_1_pooling_ae4782bcaa9306742b54d01d1f26c9837}{Pooling}} (size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a39aaffa3c994629ae48acddd980debe0}{nf}}, size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_aa5039166bf8e18418f4173f778adc199}{ni}}, size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a2d3205efd40debac2409d505fdcc7ecc}{nj}}, size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a9fc1a9baf77fa32e25ccf74c088b45d5}{p}}, size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_ab0e8c8cc580e5fdc0f86437ee95b9d94}{q}})
\item 
\mbox{\hyperlink{class_layer_1_1_pooling_adf15e44fc1480e17420808c15aa44067}{$\sim$\+Pooling}} ()
\item 
\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} \mbox{\hyperlink{class_layer_1_1_pooling_a91e5d2cfd897d0f196de969909c92afc}{feed\+\_\+forward}} (\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} \mbox{\hyperlink{class_layer_1_1_layer_af2ebcf019bc0e4b97f41fc9205706665}{x}}) override
\item 
void \mbox{\hyperlink{class_layer_1_1_pooling_a5c59ea7b198d3e42e334051f7a6e4645}{init\+\_\+nabla}} () override
\item 
\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} \mbox{\hyperlink{class_layer_1_1_pooling_a3dc9bb1a69d3d7c2f627da9d2b737ac2}{back\+\_\+propagation}} (\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} e) override
\item 
void \mbox{\hyperlink{class_layer_1_1_pooling_ab04c4682d176b4bc760aee53c0ecc36a}{update}} (\mbox{\hyperlink{vector_8hpp_a4b04262b81aa7d31eb5d2f607e2a35de}{Real}}) override
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a39aaffa3c994629ae48acddd980debe0}{nf}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_aa5039166bf8e18418f4173f778adc199}{ni}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a2d3205efd40debac2409d505fdcc7ecc}{nj}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a9fc1a9baf77fa32e25ccf74c088b45d5}{p}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_ab0e8c8cc580e5fdc0f86437ee95b9d94}{q}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a1360199bea24a84eba49c82fa7c85afa}{mi}}
\item 
size\+\_\+t \mbox{\hyperlink{class_layer_1_1_pooling_a70a33709b8f2e3d623b2b7be016e0097}{mj}}
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_layer_1_1_pooling_ae4782bcaa9306742b54d01d1f26c9837}\label{class_layer_1_1_pooling_ae4782bcaa9306742b54d01d1f26c9837}} 
\index{Layer::Pooling@{Layer::Pooling}!Pooling@{Pooling}}
\index{Pooling@{Pooling}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{Pooling()}{Pooling()}}
{\footnotesize\ttfamily Layer\+::\+Pooling\+::\+Pooling (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{nf,  }\item[{size\+\_\+t}]{ni,  }\item[{size\+\_\+t}]{nj,  }\item[{size\+\_\+t}]{p,  }\item[{size\+\_\+t}]{q }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_layer_1_1_pooling_adf15e44fc1480e17420808c15aa44067}\label{class_layer_1_1_pooling_adf15e44fc1480e17420808c15aa44067}} 
\index{Layer::Pooling@{Layer::Pooling}!````~Pooling@{$\sim$Pooling}}
\index{````~Pooling@{$\sim$Pooling}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{$\sim$Pooling()}{~Pooling()}}
{\footnotesize\ttfamily Layer\+::\+Pooling\+::$\sim$\+Pooling (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_layer_1_1_pooling_a3dc9bb1a69d3d7c2f627da9d2b737ac2}\label{class_layer_1_1_pooling_a3dc9bb1a69d3d7c2f627da9d2b737ac2}} 
\index{Layer::Pooling@{Layer::Pooling}!back\_propagation@{back\_propagation}}
\index{back\_propagation@{back\_propagation}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{back\_propagation()}{back\_propagation()}}
{\footnotesize\ttfamily \mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} Layer\+::\+Pooling\+::back\+\_\+propagation (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}}}]{e }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}

Apply back propagation algorithm on the delta output vector d. Used the input vector stored in x\+\_\+in\+\_\+ref during feedforward. Return a reference to the computed (and stored) input delta vector. Nabla vectors must be computed here. 

Implements \mbox{\hyperlink{class_layer_1_1_layer_ad9e2853fce56b014b1e9de5097e21dbd}{Layer\+::\+Layer}}.

\mbox{\Hypertarget{class_layer_1_1_pooling_a91e5d2cfd897d0f196de969909c92afc}\label{class_layer_1_1_pooling_a91e5d2cfd897d0f196de969909c92afc}} 
\index{Layer::Pooling@{Layer::Pooling}!feed\_forward@{feed\_forward}}
\index{feed\_forward@{feed\_forward}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{feed\_forward()}{feed\_forward()}}
{\footnotesize\ttfamily \mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}} Layer\+::\+Pooling\+::feed\+\_\+forward (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{vector_8hpp_ab9855a300a7759f4c0f85067d44e4c38}{Vector}}}]{x }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}

Apply the layer to the input vector {\ttfamily x}. Vectors {\ttfamily x\+\_\+in\+\_\+ref} and {\ttfamily x\+\_\+out} must be updated in consequence. Return a reference to x\+\_\+out. 

Implements \mbox{\hyperlink{class_layer_1_1_layer_aeb5b92a01bc4e867d347bff4767e919f}{Layer\+::\+Layer}}.

\mbox{\Hypertarget{class_layer_1_1_pooling_a5c59ea7b198d3e42e334051f7a6e4645}\label{class_layer_1_1_pooling_a5c59ea7b198d3e42e334051f7a6e4645}} 
\index{Layer::Pooling@{Layer::Pooling}!init\_nabla@{init\_nabla}}
\index{init\_nabla@{init\_nabla}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{init\_nabla()}{init\_nabla()}}
{\footnotesize\ttfamily void Layer\+::\+Pooling\+::init\+\_\+nabla (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [virtual]}}

Initialize nabla vectors which are used during gradient descent. 

Implements \mbox{\hyperlink{class_layer_1_1_layer_a87dbd5d1c1091769ba285084bd3513e7}{Layer\+::\+Layer}}.

\mbox{\Hypertarget{class_layer_1_1_pooling_ab04c4682d176b4bc760aee53c0ecc36a}\label{class_layer_1_1_pooling_ab04c4682d176b4bc760aee53c0ecc36a}} 
\index{Layer::Pooling@{Layer::Pooling}!update@{update}}
\index{update@{update}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{update()}{update()}}
{\footnotesize\ttfamily void Layer\+::\+Pooling\+::update (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{vector_8hpp_a4b04262b81aa7d31eb5d2f607e2a35de}{Real}}}]{eta }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [override]}, {\ttfamily [virtual]}}

Update layer parameters using gradient descent algorithm with learning rate eta. 

Implements \mbox{\hyperlink{class_layer_1_1_layer_a8f0801b946b94dfe856c57a632c9998f}{Layer\+::\+Layer}}.



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_layer_1_1_pooling_a1360199bea24a84eba49c82fa7c85afa}\label{class_layer_1_1_pooling_a1360199bea24a84eba49c82fa7c85afa}} 
\index{Layer::Pooling@{Layer::Pooling}!mi@{mi}}
\index{mi@{mi}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{mi}{mi}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::mi}

\mbox{\Hypertarget{class_layer_1_1_pooling_a70a33709b8f2e3d623b2b7be016e0097}\label{class_layer_1_1_pooling_a70a33709b8f2e3d623b2b7be016e0097}} 
\index{Layer::Pooling@{Layer::Pooling}!mj@{mj}}
\index{mj@{mj}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{mj}{mj}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::mj}

\mbox{\Hypertarget{class_layer_1_1_pooling_a39aaffa3c994629ae48acddd980debe0}\label{class_layer_1_1_pooling_a39aaffa3c994629ae48acddd980debe0}} 
\index{Layer::Pooling@{Layer::Pooling}!nf@{nf}}
\index{nf@{nf}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{nf}{nf}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::nf}

\mbox{\Hypertarget{class_layer_1_1_pooling_aa5039166bf8e18418f4173f778adc199}\label{class_layer_1_1_pooling_aa5039166bf8e18418f4173f778adc199}} 
\index{Layer::Pooling@{Layer::Pooling}!ni@{ni}}
\index{ni@{ni}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{ni}{ni}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::ni}

\mbox{\Hypertarget{class_layer_1_1_pooling_a2d3205efd40debac2409d505fdcc7ecc}\label{class_layer_1_1_pooling_a2d3205efd40debac2409d505fdcc7ecc}} 
\index{Layer::Pooling@{Layer::Pooling}!nj@{nj}}
\index{nj@{nj}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{nj}{nj}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::nj}

\mbox{\Hypertarget{class_layer_1_1_pooling_a9fc1a9baf77fa32e25ccf74c088b45d5}\label{class_layer_1_1_pooling_a9fc1a9baf77fa32e25ccf74c088b45d5}} 
\index{Layer::Pooling@{Layer::Pooling}!p@{p}}
\index{p@{p}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{p}{p}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::p}

\mbox{\Hypertarget{class_layer_1_1_pooling_ab0e8c8cc580e5fdc0f86437ee95b9d94}\label{class_layer_1_1_pooling_ab0e8c8cc580e5fdc0f86437ee95b9d94}} 
\index{Layer::Pooling@{Layer::Pooling}!q@{q}}
\index{q@{q}!Layer::Pooling@{Layer::Pooling}}
\doxysubsubsection{\texorpdfstring{q}{q}}
{\footnotesize\ttfamily size\+\_\+t Layer\+::\+Pooling\+::q}



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
src/layers/\mbox{\hyperlink{pooling_8hpp}{pooling.\+hpp}}\item 
src/layers/\mbox{\hyperlink{pooling_8cpp}{pooling.\+cpp}}\end{DoxyCompactItemize}