\hypertarget{a00114}{
\section{mln::accu::stat::deviation$<$ T, S, M $>$ Struct Template Reference}
\label{d8/d17/a00114}\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}}
}


Generic standard deviation accumulator class.  




{\ttfamily \#include $<$deviation.hh$>$}



Inherits base$<$ M, deviation$<$ T, S, M $>$ $>$.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
bool \hyperlink{a00114_ae3d1add24ca0192f643e229e03ff49d1}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Check whether this accu is able to return a result. \item\end{DoxyCompactList}\item 
void \hyperlink{a00026_a745794a4ef16926d3c09ebbaa8b6b557}{take\_\-as\_\-init} (const T \&t)
\begin{DoxyCompactList}\small\item\em Take as initialization the value {\ttfamily t}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00026_a138e094daa1a85f345bbdfd852c9fc67}{take\_\-n\_\-times} (unsigned n, const T \&t)
\begin{DoxyCompactList}\small\item\em Take {\ttfamily n} times the value {\ttfamily t}. \item\end{DoxyCompactList}\item 
M \hyperlink{a00114_a8df94c4b6b68ae05c12407de5c69b5fa}{to\_\-result} () const 
\begin{DoxyCompactList}\small\item\em Get the value of the accumulator. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
void \hyperlink{a00114_ace42c44c1fd954bd3f6fdad32fba67be}{init} ()
\begin{DoxyCompactList}\small\item\em Manipulators. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}


\subsection{Detailed Description}
\subsubsection*{template$<$typename T, typename S = typename mln::value::props$<$  T  $>$::sum, typename M = S$>$ struct mln::accu::stat::deviation$<$ T, S, M $>$}

Generic standard deviation accumulator class. Parameter {\ttfamily T} is the type of values that we sum. Parameter {\ttfamily S} is the type to store the standard deviation; the default type of {\ttfamily S} is the summation type (property) of {\ttfamily T}. Parameter {\ttfamily M} is the type of the mean value; the default type of {\ttfamily M} is {\ttfamily S}. 

Definition at line 62 of file deviation.hh.



\subsection{Member Function Documentation}
\hypertarget{a00114_ace42c44c1fd954bd3f6fdad32fba67be}{
\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}!init@{init}}
\index{init@{init}!mln::accu::stat::deviation@{mln::accu::stat::deviation}}
\subsubsection[{init}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename S , typename M $>$ void {\bf mln::accu::stat::deviation}$<$ T, S, M $>$::init (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d8/d17/a00114_ace42c44c1fd954bd3f6fdad32fba67be}


Manipulators. 



Definition at line 132 of file deviation.hh.

\hypertarget{a00114_ae3d1add24ca0192f643e229e03ff49d1}{
\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::accu::stat::deviation@{mln::accu::stat::deviation}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename S , typename M $>$ bool {\bf mln::accu::stat::deviation}$<$ T, S, M $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d8/d17/a00114_ae3d1add24ca0192f643e229e03ff49d1}


Check whether this accu is able to return a result. 

Always true here. 

Definition at line 177 of file deviation.hh.

\hypertarget{a00026_a745794a4ef16926d3c09ebbaa8b6b557}{
\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}!take\_\-as\_\-init@{take\_\-as\_\-init}}
\index{take\_\-as\_\-init@{take\_\-as\_\-init}!mln::accu::stat::deviation@{mln::accu::stat::deviation}}
\subsubsection[{take\_\-as\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf mln::Accumulator}$<$ {\bf deviation}$<$ T, S, M $>$  $>$::take\_\-as\_\-init (
\begin{DoxyParamCaption}
\item[{const T \&}]{ t}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/d5b/a00026_a745794a4ef16926d3c09ebbaa8b6b557}


Take as initialization the value {\ttfamily t}. 

Dev note: this is a final method; override if needed by take\_\-as\_\-init\_\- (ending with '\_\-'). \hypertarget{a00026_a138e094daa1a85f345bbdfd852c9fc67}{
\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}!take\_\-n\_\-times@{take\_\-n\_\-times}}
\index{take\_\-n\_\-times@{take\_\-n\_\-times}!mln::accu::stat::deviation@{mln::accu::stat::deviation}}
\subsubsection[{take\_\-n\_\-times}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf mln::Accumulator}$<$ {\bf deviation}$<$ T, S, M $>$  $>$::take\_\-n\_\-times (
\begin{DoxyParamCaption}
\item[{unsigned}]{ n, }
\item[{const T \&}]{ t}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/d5b/a00026_a138e094daa1a85f345bbdfd852c9fc67}


Take {\ttfamily n} times the value {\ttfamily t}. 

Dev note: this is a final method; override if needed by take\_\-as\_\-init\_\- (ending with '\_\-'). \hypertarget{a00114_a8df94c4b6b68ae05c12407de5c69b5fa}{
\index{mln::accu::stat::deviation@{mln::accu::stat::deviation}!to\_\-result@{to\_\-result}}
\index{to\_\-result@{to\_\-result}!mln::accu::stat::deviation@{mln::accu::stat::deviation}}
\subsubsection[{to\_\-result}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename S , typename M $>$ M {\bf mln::accu::stat::deviation}$<$ T, S, M $>$::to\_\-result (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d8/d17/a00114_a8df94c4b6b68ae05c12407de5c69b5fa}


Get the value of the accumulator. 



Definition at line 159 of file deviation.hh.

