\section{Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$ Class Template Reference}
\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss}\index{Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$@{Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$}}


The Hinge Embedding loss function is often used to compute the loss between y\+\_\+true and y\+\_\+pred.  


\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\textbf{ Hinge\+Embedding\+Loss} ()
\begin{DoxyCompactList}\small\item\em Create the Hinge Embedding object. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Input\+Type , typename Target\+Type , typename Output\+Type $>$ }\\void \textbf{ Backward} (const Input\+Type \&input, const Target\+Type \&target, Output\+Type \&output)
\begin{DoxyCompactList}\small\item\em Ordinary feed backward pass of a neural network. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Input\+Type , typename Target\+Type $>$ }\\Input\+Type\+::elem\+\_\+type \textbf{ Forward} (const Input\+Type \&input, const Target\+Type \&target)
\begin{DoxyCompactList}\small\item\em Computes the Hinge Embedding loss function. \end{DoxyCompactList}\item 
Output\+Data\+Type \& \textbf{ Output\+Parameter} () const
\begin{DoxyCompactList}\small\item\em Get the output parameter. \end{DoxyCompactList}\item 
Output\+Data\+Type \& \textbf{ Output\+Parameter} ()
\begin{DoxyCompactList}\small\item\em Modify the output parameter. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Archive $>$ }\\void \textbf{ serialize} (Archive \&ar, const unsigned int)
\begin{DoxyCompactList}\small\item\em Serialize the loss function. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename Input\+Data\+Type = arma\+::mat, typename Output\+Data\+Type = arma\+::mat$>$\newline
class mlpack\+::ann\+::\+Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$}

The Hinge Embedding loss function is often used to compute the loss between y\+\_\+true and y\+\_\+pred. 


\begin{DoxyTemplParams}{Template Parameters}
{\em Input\+Data\+Type} & Type of the input data (arma\+::colvec, arma\+::mat, arma\+::sp\+\_\+mat or arma\+::cube). \\
\hline
{\em Output\+Data\+Type} & Type of the output data (arma\+::colvec, arma\+::mat, arma\+::sp\+\_\+mat or arma\+::cube). \\
\hline
\end{DoxyTemplParams}


Definition at line 36 of file hinge\+\_\+embedding\+\_\+loss.\+hpp.



\subsection{Constructor \& Destructor Documentation}
\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_a2289f44104560cff137f0ec305869d77}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!Hinge\+Embedding\+Loss@{Hinge\+Embedding\+Loss}}
\index{Hinge\+Embedding\+Loss@{Hinge\+Embedding\+Loss}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{Hinge\+Embedding\+Loss()}
{\footnotesize\ttfamily \textbf{ Hinge\+Embedding\+Loss} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Create the Hinge Embedding object. 



\subsection{Member Function Documentation}
\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_a7a5e88245fe9cf5644f846902393e97a}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!Backward@{Backward}}
\index{Backward@{Backward}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{Backward()}
{\footnotesize\ttfamily void Backward (\begin{DoxyParamCaption}\item[{const Input\+Type \&}]{input,  }\item[{const Target\+Type \&}]{target,  }\item[{Output\+Type \&}]{output }\end{DoxyParamCaption})}



Ordinary feed backward pass of a neural network. 


\begin{DoxyParams}{Parameters}
{\em input} & The propagated input activation. \\
\hline
{\em target} & The target vector. \\
\hline
{\em output} & The calculated error. \\
\hline
\end{DoxyParams}
\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_aad9536a75d4ecfe220d313adc47f38fa}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!Forward@{Forward}}
\index{Forward@{Forward}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{Forward()}
{\footnotesize\ttfamily Input\+Type\+::elem\+\_\+type Forward (\begin{DoxyParamCaption}\item[{const Input\+Type \&}]{input,  }\item[{const Target\+Type \&}]{target }\end{DoxyParamCaption})}



Computes the Hinge Embedding loss function. 


\begin{DoxyParams}{Parameters}
{\em input} & Input data used for evaluating the specified function. \\
\hline
{\em target} & Target data to compare with. \\
\hline
\end{DoxyParams}
\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_a8bae962cc603d1cab8d80ec78f8d505d}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!Output\+Parameter@{Output\+Parameter}}
\index{Output\+Parameter@{Output\+Parameter}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{Output\+Parameter()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Output\+Data\+Type\& Output\+Parameter (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the output parameter. 



Definition at line 67 of file hinge\+\_\+embedding\+\_\+loss.\+hpp.

\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_a21d5f745f02c709625a4ee0907f004a5}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!Output\+Parameter@{Output\+Parameter}}
\index{Output\+Parameter@{Output\+Parameter}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{Output\+Parameter()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Output\+Data\+Type\& Output\+Parameter (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify the output parameter. 



Definition at line 69 of file hinge\+\_\+embedding\+\_\+loss.\+hpp.



References Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$\+::serialize().

\mbox{\label{classmlpack_1_1ann_1_1HingeEmbeddingLoss_af0dd9205158ccf7bcfcd8ff81f79c927}} 
\index{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}!serialize@{serialize}}
\index{serialize@{serialize}!mlpack\+::ann\+::\+Hinge\+Embedding\+Loss@{mlpack\+::ann\+::\+Hinge\+Embedding\+Loss}}
\subsubsection{serialize()}
{\footnotesize\ttfamily void serialize (\begin{DoxyParamCaption}\item[{Archive \&}]{ar,  }\item[{const unsigned}]{int }\end{DoxyParamCaption})}



Serialize the loss function. 



Referenced by Hinge\+Embedding\+Loss$<$ Input\+Data\+Type, Output\+Data\+Type $>$\+::\+Output\+Parameter().



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/var/www/mlpack.\+ratml.\+org/mlpack.\+org/\+\_\+src/mlpack-\/3.\+3.\+1/src/mlpack/methods/ann/loss\+\_\+functions/\textbf{ hinge\+\_\+embedding\+\_\+loss.\+hpp}\end{DoxyCompactItemize}