\section{Hyperbolic\+Tangent\+Kernel Class Reference}
\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel}\index{Hyperbolic\+Tangent\+Kernel@{Hyperbolic\+Tangent\+Kernel}}


Hyperbolic tangent kernel.  


\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\textbf{ Hyperbolic\+Tangent\+Kernel} ()
\begin{DoxyCompactList}\small\item\em This constructor sets the default scale to 1.\+0 and offset to 0.\+0. \end{DoxyCompactList}\item 
\textbf{ Hyperbolic\+Tangent\+Kernel} (double scale, double offset)
\begin{DoxyCompactList}\small\item\em Construct the hyperbolic tangent kernel with custom scale factor and offset. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Vec\+TypeA , typename Vec\+TypeB $>$ }\\double \textbf{ Evaluate} (const Vec\+TypeA \&a, const Vec\+TypeB \&b)
\begin{DoxyCompactList}\small\item\em Evaluate the hyperbolic tangent kernel. \end{DoxyCompactList}\item 
double \textbf{ Offset} () const
\begin{DoxyCompactList}\small\item\em Get offset for the kernel. \end{DoxyCompactList}\item 
double \& \textbf{ Offset} ()
\begin{DoxyCompactList}\small\item\em Modify offset for the kernel. \end{DoxyCompactList}\item 
double \textbf{ Scale} () const
\begin{DoxyCompactList}\small\item\em Get scale factor. \end{DoxyCompactList}\item 
double \& \textbf{ Scale} ()
\begin{DoxyCompactList}\small\item\em Modify scale factor. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Archive $>$ }\\void \textbf{ serialize} (Archive \&ar, const unsigned int)
\begin{DoxyCompactList}\small\item\em Serialize the kernel. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Hyperbolic tangent kernel. 

For any two vectors $ x $, $ y $ and a given scale $ s $ and offset $ t $

\[ K(x, y) = \tanh(s <x, y> + t) \] 

Definition at line 28 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.



\subsection{Constructor \& Destructor Documentation}
\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_a034bf026d167ae52a3d35d5bd8f552e7}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Hyperbolic\+Tangent\+Kernel@{Hyperbolic\+Tangent\+Kernel}}
\index{Hyperbolic\+Tangent\+Kernel@{Hyperbolic\+Tangent\+Kernel}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Hyperbolic\+Tangent\+Kernel()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \textbf{ Hyperbolic\+Tangent\+Kernel} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



This constructor sets the default scale to 1.\+0 and offset to 0.\+0. 



Definition at line 34 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_aba0806631693a6fd7451e27d878b3665}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Hyperbolic\+Tangent\+Kernel@{Hyperbolic\+Tangent\+Kernel}}
\index{Hyperbolic\+Tangent\+Kernel@{Hyperbolic\+Tangent\+Kernel}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Hyperbolic\+Tangent\+Kernel()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \textbf{ Hyperbolic\+Tangent\+Kernel} (\begin{DoxyParamCaption}\item[{double}]{scale,  }\item[{double}]{offset }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Construct the hyperbolic tangent kernel with custom scale factor and offset. 


\begin{DoxyParams}{Parameters}
{\em scale} & Scaling factor for $<$x, y$>$. \\
\hline
{\em offset} & Kernel offset. \\
\hline
\end{DoxyParams}


Definition at line 44 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.



\subsection{Member Function Documentation}
\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_a7bc3cfc0ee3750ba84ee4dc7f62994ae}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Evaluate@{Evaluate}}
\index{Evaluate@{Evaluate}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Evaluate()}
{\footnotesize\ttfamily double Evaluate (\begin{DoxyParamCaption}\item[{const Vec\+TypeA \&}]{a,  }\item[{const Vec\+TypeB \&}]{b }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Evaluate the hyperbolic tangent kernel. 

This evaluation uses Armadillo\textquotesingle{}s dot() function.


\begin{DoxyTemplParams}{Template Parameters}
{\em Vec\+TypeA} & Type of first vector (should be arma\+::vec or arma\+::sp\+\_\+vec). \\
\hline
{\em Vec\+TypeB} & Type of second vector (arma\+::vec / arma\+::sp\+\_\+vec). \\
\hline
\end{DoxyTemplParams}

\begin{DoxyParams}{Parameters}
{\em a} & First vector. \\
\hline
{\em b} & Second vector. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
K(a, b). 
\end{DoxyReturn}


Definition at line 60 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_a9ed024e37386d2b9c8976b221c237ab8}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Offset@{Offset}}
\index{Offset@{Offset}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Offset()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily double Offset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get offset for the kernel. 



Definition at line 71 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_a37ef08fdb2295b040e6c3a59cf907249}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Offset@{Offset}}
\index{Offset@{Offset}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Offset()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily double\& Offset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify offset for the kernel. 



Definition at line 73 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_ab30d1e52df44eb451081926df999fc17}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Scale@{Scale}}
\index{Scale@{Scale}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Scale()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily double Scale (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get scale factor. 



Definition at line 66 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_a8190151e4134e9f69f1f51cd013ba43c}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!Scale@{Scale}}
\index{Scale@{Scale}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{Scale()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily double\& Scale (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify scale factor. 



Definition at line 68 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.

\mbox{\label{classmlpack_1_1kernel_1_1HyperbolicTangentKernel_af0dd9205158ccf7bcfcd8ff81f79c927}} 
\index{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}!serialize@{serialize}}
\index{serialize@{serialize}!mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel@{mlpack\+::kernel\+::\+Hyperbolic\+Tangent\+Kernel}}
\subsubsection{serialize()}
{\footnotesize\ttfamily void serialize (\begin{DoxyParamCaption}\item[{Archive \&}]{ar,  }\item[{const unsigned}]{int }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Serialize the kernel. 



Definition at line 77 of file hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp.



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.\+2/src/mlpack/core/kernels/\textbf{ hyperbolic\+\_\+tangent\+\_\+kernel.\+hpp}\end{DoxyCompactItemize}
