\hypertarget{number_8ic}{
\section{number.ic File Reference}
\label{number_8ic}\index{number.ic@{number.ic}}
}
Static inline functions that calculate some numerical values. 

{\tt \#include \char`\"{}AG\_\-number\_\-s.h\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par


Include dependency graph for number.ic:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=120pt]{number_8ic__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=102pt]{number_8ic__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static size\_\-t \hyperlink{number_8ic_a0}{sizeof\-Map} (\hyperlink{lrd_8h_a0}{RIM\_\-type} type)
\begin{CompactList}\small\item\em Return the size of the 32-bit word bit-map that would hold enough bits to map all the instances of this type. \item\end{CompactList}\item 
static void \hyperlink{number_8ic_a1}{clear\-Map} (unsigned $\ast$map, \hyperlink{lrd_8h_a0}{RIM\_\-type} type)
\begin{CompactList}\small\item\em Set all bits to zero. \item\end{CompactList}\item 
static void \hyperlink{number_8ic_a2}{set\-Map} (unsigned $\ast$map, \hyperlink{lrd_8h_a0}{RIM\_\-type} type)
\begin{CompactList}\small\item\em Set all bits to one. \item\end{CompactList}\item 
static unsigned \hyperlink{number_8ic_a3}{count\-Map} (const unsigned $\ast$map, \hyperlink{lrd_8h_a0}{RIM\_\-type} type)
\begin{CompactList}\small\item\em Count the number of set bits. \item\end{CompactList}\item 
static void \hyperlink{number_8ic_a4}{set\-Bit} (unsigned $\ast$map, unsigned index)
\begin{CompactList}\small\item\em Set bit {\em i\/}. \item\end{CompactList}\item 
static void \hyperlink{number_8ic_a5}{clear\-Bit} (unsigned $\ast$map, unsigned index)
\begin{CompactList}\small\item\em Clear bit {\em i\/}. \item\end{CompactList}\item 
static int \hyperlink{number_8ic_a6}{check\-Bit} (const unsigned $\ast$map, unsigned index)
\begin{CompactList}\small\item\em Check bit {\em i\/}. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Static inline functions that calculate some numerical values. 

\begin{Desc}
\item[Author:]James Swain -- \href{mailto:jswain@slac.stanford.edu}{\tt jswain@slac.stanford.edu}\end{Desc}


\subsection{Function Documentation}
\hypertarget{number_8ic_a6}{
\index{number.ic@{number.ic}!checkBit@{checkBit}}
\index{checkBit@{checkBit}!number.ic@{number.ic}}
\subsubsection[checkBit]{\setlength{\rightskip}{0pt plus 5cm}int check\-Bit (const unsigned $\ast$ {\em map}, unsigned {\em i})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a6}


Check bit {\em i\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em i}]Bit to check \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Value of the bit being checked (0/1)\end{Desc}
\hypertarget{number_8ic_a5}{
\index{number.ic@{number.ic}!clearBit@{clearBit}}
\index{clearBit@{clearBit}!number.ic@{number.ic}}
\subsubsection[clearBit]{\setlength{\rightskip}{0pt plus 5cm}void clear\-Bit (unsigned $\ast$ {\em map}, unsigned {\em i})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a5}


Clear bit {\em i\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em i}]Bit to clear\end{description}
\end{Desc}
\hypertarget{number_8ic_a1}{
\index{number.ic@{number.ic}!clearMap@{clearMap}}
\index{clearMap@{clearMap}!number.ic@{number.ic}}
\subsubsection[clearMap]{\setlength{\rightskip}{0pt plus 5cm}void clear\-Map (unsigned $\ast$ {\em map}, \hyperlink{lrd_8h_a0}{RIM\_\-type} {\em type})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a1}


Set all bits to zero. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em type}]Component type to be mapped\end{description}
\end{Desc}
\hypertarget{number_8ic_a3}{
\index{number.ic@{number.ic}!countMap@{countMap}}
\index{countMap@{countMap}!number.ic@{number.ic}}
\subsubsection[countMap]{\setlength{\rightskip}{0pt plus 5cm}unsigned count\-Map (const unsigned $\ast$ {\em map}, \hyperlink{lrd_8h_a0}{RIM\_\-type} {\em type})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a3}


Count the number of set bits. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em type}]Component type to be mapped \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Number of set bits\end{Desc}
\hypertarget{number_8ic_a4}{
\index{number.ic@{number.ic}!setBit@{setBit}}
\index{setBit@{setBit}!number.ic@{number.ic}}
\subsubsection[setBit]{\setlength{\rightskip}{0pt plus 5cm}void set\-Bit (unsigned $\ast$ {\em map}, unsigned {\em i})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a4}


Set bit {\em i\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em i}]Bit to set\end{description}
\end{Desc}
\hypertarget{number_8ic_a2}{
\index{number.ic@{number.ic}!setMap@{setMap}}
\index{setMap@{setMap}!number.ic@{number.ic}}
\subsubsection[setMap]{\setlength{\rightskip}{0pt plus 5cm}void set\-Map (unsigned $\ast$ {\em map}, \hyperlink{lrd_8h_a0}{RIM\_\-type} {\em type})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a2}


Set all bits to one. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em map}]Map being manipulated \item[{\em type}]Component type to be mapped\end{description}
\end{Desc}
\hypertarget{number_8ic_a0}{
\index{number.ic@{number.ic}!sizeofMap@{sizeofMap}}
\index{sizeofMap@{sizeofMap}!number.ic@{number.ic}}
\subsubsection[sizeofMap]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t sizeof\-Map (\hyperlink{lrd_8h_a0}{RIM\_\-type} {\em type})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{number_8ic_a0}


Return the size of the 32-bit word bit-map that would hold enough bits to map all the instances of this type. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type}]Component type to be mapped \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Corresponding map size.\end{Desc}