\hypertarget{a00425}{
\section{mln::value::int\_\-u\_\-sat$<$ n $>$ Struct Template Reference}
\label{dc/d2f/a00425}\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}}
}


Unsigned integer value class with saturation behavior.  




{\ttfamily \#include $<$int\_\-u\_\-sat.hh$>$}



Inheritance diagram for mln::value::int\_\-u\_\-sat$<$ n $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=280pt]{d1/ded/a04035}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00425_ac9bea2709005e6b673a21d49d9991a38}{int\_\-u\_\-sat} ()
\begin{DoxyCompactList}\small\item\em Constructor without argument. \item\end{DoxyCompactList}\item 
\hyperlink{a00425_aa0b296a9e0ce9808c1c0047b01839104}{int\_\-u\_\-sat} (int i)
\begin{DoxyCompactList}\small\item\em Constructor from an integer. \item\end{DoxyCompactList}\item 
\hyperlink{a00425_a0363564c28f92b1ffd0ded1f77a72e67}{operator int} () const 
\begin{DoxyCompactList}\small\item\em Conversion to an integer. \item\end{DoxyCompactList}\item 
\hyperlink{a00425}{int\_\-u\_\-sat}$<$ n $>$ \& \hyperlink{a00425_a9eae85e98045256da4f5d95adc5718ea}{operator+=} (int i)
\begin{DoxyCompactList}\small\item\em Self addition. \item\end{DoxyCompactList}\item 
\hyperlink{a00425}{int\_\-u\_\-sat}$<$ n $>$ \& \hyperlink{a00425_a360706e1806f05250fac3e46e8e656b3}{operator-\/=} (int i)
\begin{DoxyCompactList}\small\item\em Self subtraction. \item\end{DoxyCompactList}\item 
\hyperlink{a00425}{int\_\-u\_\-sat}$<$ n $>$ \& \hyperlink{a00425_acc9f00192c769f95845c6e38e4cb9101}{operator=} (int i)
\begin{DoxyCompactList}\small\item\em Assignment from an integer. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static const \hyperlink{a00425}{int\_\-u\_\-sat}$<$ n $>$ \hyperlink{a00425_a0b2064ce8adb5fcf9eaa820a41fda410}{one} = 1
\begin{DoxyCompactList}\small\item\em Unit value. \item\end{DoxyCompactList}\item 
static const \hyperlink{a00425}{int\_\-u\_\-sat}$<$ n $>$ \hyperlink{a00425_a0a2ce1f684e401eb22bbd978caeed044}{zero} = 0
\begin{DoxyCompactList}\small\item\em Zero value. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$unsigned n$>$ struct mln::value::int\_\-u\_\-sat$<$ n $>$}

Unsigned integer value class with saturation behavior. The parameter is {\ttfamily n} the number of encoding bits. 

Definition at line 90 of file int\_\-u\_\-sat.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00425_ac9bea2709005e6b673a21d49d9991a38}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!int\_\-u\_\-sat@{int\_\-u\_\-sat}}
\index{int\_\-u\_\-sat@{int\_\-u\_\-sat}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{int\_\-u\_\-sat}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::{\bf int\_\-u\_\-sat} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_ac9bea2709005e6b673a21d49d9991a38}


Constructor without argument. 



Definition at line 149 of file int\_\-u\_\-sat.hh.

\hypertarget{a00425_aa0b296a9e0ce9808c1c0047b01839104}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!int\_\-u\_\-sat@{int\_\-u\_\-sat}}
\index{int\_\-u\_\-sat@{int\_\-u\_\-sat}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{int\_\-u\_\-sat}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::{\bf int\_\-u\_\-sat} (
\begin{DoxyParamCaption}
\item[{int}]{ i}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_aa0b296a9e0ce9808c1c0047b01839104}


Constructor from an integer. 



Definition at line 155 of file int\_\-u\_\-sat.hh.



\subsection{Member Function Documentation}
\hypertarget{a00425_a0363564c28f92b1ffd0ded1f77a72e67}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!operator int@{operator int}}
\index{operator int@{operator int}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{operator int}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::operator int (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_a0363564c28f92b1ffd0ded1f77a72e67}


Conversion to an integer. 



Definition at line 170 of file int\_\-u\_\-sat.hh.

\hypertarget{a00425_a9eae85e98045256da4f5d95adc5718ea}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{operator+=}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf int\_\-u\_\-sat}$<$ n $>$ \& {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::operator+= (
\begin{DoxyParamCaption}
\item[{int}]{ i}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_a9eae85e98045256da4f5d95adc5718ea}


Self addition. 



Definition at line 195 of file int\_\-u\_\-sat.hh.

\hypertarget{a00425_a360706e1806f05250fac3e46e8e656b3}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!operator-\/=@{operator-\/=}}
\index{operator-\/=@{operator-\/=}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{operator-\/=}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf int\_\-u\_\-sat}$<$ n $>$ \& {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::operator-\/= (
\begin{DoxyParamCaption}
\item[{int}]{ i}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_a360706e1806f05250fac3e46e8e656b3}


Self subtraction. 



Definition at line 205 of file int\_\-u\_\-sat.hh.

\hypertarget{a00425_acc9f00192c769f95845c6e38e4cb9101}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!operator=@{operator=}}
\index{operator=@{operator=}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ {\bf int\_\-u\_\-sat}$<$ n $>$ \& {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::operator= (
\begin{DoxyParamCaption}
\item[{int}]{ i}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/d2f/a00425_acc9f00192c769f95845c6e38e4cb9101}


Assignment from an integer. 



Definition at line 178 of file int\_\-u\_\-sat.hh.



\subsection{Member Data Documentation}
\hypertarget{a00425_a0b2064ce8adb5fcf9eaa820a41fda410}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!one@{one}}
\index{one@{one}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{one}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ const {\bf int\_\-u\_\-sat}$<$ n $>$ {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::{\bf one} = 1\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{dc/d2f/a00425_a0b2064ce8adb5fcf9eaa820a41fda410}


Unit value. 



Definition at line 115 of file int\_\-u\_\-sat.hh.

\hypertarget{a00425_a0a2ce1f684e401eb22bbd978caeed044}{
\index{mln::value::int\_\-u\_\-sat@{mln::value::int\_\-u\_\-sat}!zero@{zero}}
\index{zero@{zero}!mln::value::int_u_sat@{mln::value::int\_\-u\_\-sat}}
\subsubsection[{zero}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned n$>$ const {\bf int\_\-u\_\-sat}$<$ n $>$ {\bf mln::value::int\_\-u\_\-sat}$<$ n $>$::{\bf zero} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{dc/d2f/a00425_a0a2ce1f684e401eb22bbd978caeed044}


Zero value. 



Definition at line 112 of file int\_\-u\_\-sat.hh.

