\hypertarget{a00109}{
\section{mln::accu::rms$<$ T, V $>$ Struct Template Reference}
\label{dd/d42/a00109}\index{mln::accu::rms@{mln::accu::rms}}
}


Generic root mean square accumulator class.  




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



Inherits base$<$ V, rms$<$ T, V $>$ $>$.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
bool \hyperlink{a00109_aa615b0063687b9203e502836c3c31e5a}{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 
V \hyperlink{a00109_a0b17ffd22ff57d51179dfc0f3bda9242}{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{a00109_a22e8dc49d8161ad02448f55175faa637}{init} ()
\begin{DoxyCompactList}\small\item\em Manipulators. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}


\subsection{Detailed Description}
\subsubsection*{template$<$typename T, typename V$>$ struct mln::accu::rms$<$ T, V $>$}

Generic root mean square accumulator class. The parameter {\ttfamily T} is the type of the root mean square value. 

Definition at line 52 of file accu/rms.hh.



\subsection{Member Function Documentation}
\hypertarget{a00109_a22e8dc49d8161ad02448f55175faa637}{
\index{mln::accu::rms@{mln::accu::rms}!init@{init}}
\index{init@{init}!mln::accu::rms@{mln::accu::rms}}
\subsubsection[{init}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename V $>$ void {\bf mln::accu::rms}$<$ T, V $>$::init (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dd/d42/a00109_a22e8dc49d8161ad02448f55175faa637}


Manipulators. 



Definition at line 112 of file accu/rms.hh.



References mln::literal::zero.

\hypertarget{a00109_aa615b0063687b9203e502836c3c31e5a}{
\index{mln::accu::rms@{mln::accu::rms}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::accu::rms@{mln::accu::rms}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename V $>$ bool {\bf mln::accu::rms}$<$ T, V $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dd/d42/a00109_aa615b0063687b9203e502836c3c31e5a}


Check whether this accu is able to return a result. 

Always true here. 

Definition at line 166 of file accu/rms.hh.

\hypertarget{a00026_a745794a4ef16926d3c09ebbaa8b6b557}{
\index{mln::accu::rms@{mln::accu::rms}!take\_\-as\_\-init@{take\_\-as\_\-init}}
\index{take\_\-as\_\-init@{take\_\-as\_\-init}!mln::accu::rms@{mln::accu::rms}}
\subsubsection[{take\_\-as\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf mln::Accumulator}$<$ {\bf rms}$<$ T, V $>$  $>$::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::rms@{mln::accu::rms}!take\_\-n\_\-times@{take\_\-n\_\-times}}
\index{take\_\-n\_\-times@{take\_\-n\_\-times}!mln::accu::rms@{mln::accu::rms}}
\subsubsection[{take\_\-n\_\-times}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf mln::Accumulator}$<$ {\bf rms}$<$ T, V $>$  $>$::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{a00109_a0b17ffd22ff57d51179dfc0f3bda9242}{
\index{mln::accu::rms@{mln::accu::rms}!to\_\-result@{to\_\-result}}
\index{to\_\-result@{to\_\-result}!mln::accu::rms@{mln::accu::rms}}
\subsubsection[{to\_\-result}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T , typename V $>$ V {\bf mln::accu::rms}$<$ T, V $>$::to\_\-result (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dd/d42/a00109_a0b17ffd22ff57d51179dfc0f3bda9242}


Get the value of the accumulator. 



Definition at line 148 of file accu/rms.hh.

