\hypertarget{bitmap_8h}{\section{opal/mca/hwloc/hwloc132/hwloc/include/hwloc/bitmap.h File Reference}
\label{bitmap_8h}\index{opal/mca/hwloc/hwloc132/hwloc/include/hwloc/bitmap.\+h@{opal/mca/hwloc/hwloc132/hwloc/include/hwloc/bitmap.\+h}}
}


The bitmap A\+P\+I, for use in hwloc itself.  


{\ttfamily \#include $<$hwloc/autogen/config.\+h$>$}\\*
{\ttfamily \#include $<$assert.\+h$>$}\\*
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__hwlocality__bitmap_ga3f6861045a8029ade373510ffa727d2a}{hwloc\+\_\+bitmap\+\_\+foreach\+\_\+begin}(id, bitmap)
\begin{DoxyCompactList}\small\item\em Loop macro iterating on bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\#define {\bfseries hwloc\+\_\+bitmap\+\_\+foreach\+\_\+end}()
\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{typedef struct \hyperlink{structhwloc__bitmap__s}{hwloc\+\_\+bitmap\+\_\+s} $\ast$ \hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t}}\label{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}

\begin{DoxyCompactList}\small\item\em Set of bits represented as an opaque pointer to an internal bitmap. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{typedef const struct \\*
\hyperlink{structhwloc__bitmap__s}{hwloc\+\_\+bitmap\+\_\+s} $\ast$ \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t}}\label{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}

\begin{DoxyCompactList}\small\item\em a non-\/modifiable \hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} \hyperlink{group__hwlocality__bitmap_ga9fb6aedc30d4ef4998fa53e2403b6130}{hwloc\+\_\+bitmap\+\_\+alloc} (void) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+malloc
\begin{DoxyCompactList}\small\item\em Allocate a new empty bitmap. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} \hyperlink{group__hwlocality__bitmap_gadd4479485685bda179f4b8b9b70f671e}{hwloc\+\_\+bitmap\+\_\+alloc\+\_\+full} (void) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+malloc
\begin{DoxyCompactList}\small\item\em Allocate a new full bitmap. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga8e7035fe555ef96921bfb98e08519bc7}{hwloc\+\_\+bitmap\+\_\+free} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap)
\begin{DoxyCompactList}\small\item\em Free bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} \hyperlink{group__hwlocality__bitmap_gaaa4ed76211cd3694dfbea2109fc440be}{hwloc\+\_\+bitmap\+\_\+dup} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+malloc
\begin{DoxyCompactList}\small\item\em Duplicate bitmap {\ttfamily bitmap} by allocating a new bitmap and copying {\ttfamily bitmap} contents. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gab14743355fa03b36cef521cbcd2fbf64}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_gab14743355fa03b36cef521cbcd2fbf64}{hwloc\+\_\+bitmap\+\_\+copy} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} dst, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} src)}\label{group__hwlocality__bitmap_gab14743355fa03b36cef521cbcd2fbf64}

\begin{DoxyCompactList}\small\item\em Copy the contents of bitmap {\ttfamily src} into the already allocated bitmap {\ttfamily dst}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga6c0d60db98f27276752c1e5fafcbd7d1}{hwloc\+\_\+bitmap\+\_\+snprintf} (char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict buf, size\+\_\+t buflen, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)
\begin{DoxyCompactList}\small\item\em Stringify a bitmap. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gad3cf87ceb58aa91656756bbb58057320}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gad3cf87ceb58aa91656756bbb58057320}{hwloc\+\_\+bitmap\+\_\+asprintf} (char $\ast$$\ast$strp, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_gad3cf87ceb58aa91656756bbb58057320}

\begin{DoxyCompactList}\small\item\em Stringify a bitmap into a newly allocated string. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga553cd5ceb1925bfd31788e70b4a46ae8}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga553cd5ceb1925bfd31788e70b4a46ae8}{hwloc\+\_\+bitmap\+\_\+sscanf} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, const char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict string)}\label{group__hwlocality__bitmap_ga553cd5ceb1925bfd31788e70b4a46ae8}

\begin{DoxyCompactList}\small\item\em Parse a bitmap string and stores it in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gab94b52560ea4333663895b3276e89af2}{hwloc\+\_\+bitmap\+\_\+list\+\_\+snprintf} (char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict buf, size\+\_\+t buflen, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)
\begin{DoxyCompactList}\small\item\em Stringify a bitmap in the list format. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga600651f00d39d378f423acbd75d938d2}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga600651f00d39d378f423acbd75d938d2}{hwloc\+\_\+bitmap\+\_\+list\+\_\+asprintf} (char $\ast$$\ast$strp, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_ga600651f00d39d378f423acbd75d938d2}

\begin{DoxyCompactList}\small\item\em Stringify a bitmap into a newly allocated list string. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gafe8fc90e7a9171e287cf1bfa11e85980}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gafe8fc90e7a9171e287cf1bfa11e85980}{hwloc\+\_\+bitmap\+\_\+list\+\_\+sscanf} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, const char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict string)}\label{group__hwlocality__bitmap_gafe8fc90e7a9171e287cf1bfa11e85980}

\begin{DoxyCompactList}\small\item\em Parse a list string and stores it in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gae0e0619f43a4af5efafb75f489c1c6ec}{hwloc\+\_\+bitmap\+\_\+taskset\+\_\+snprintf} (char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict buf, size\+\_\+t buflen, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)
\begin{DoxyCompactList}\small\item\em Stringify a bitmap in the taskset-\/specific format. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gaa3df92e204ffb24ceddd44d8d58f6eaa}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gaa3df92e204ffb24ceddd44d8d58f6eaa}{hwloc\+\_\+bitmap\+\_\+taskset\+\_\+asprintf} (char $\ast$$\ast$strp, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_gaa3df92e204ffb24ceddd44d8d58f6eaa}

\begin{DoxyCompactList}\small\item\em Stringify a bitmap into a newly allocated taskset-\/specific string. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga71b28ef0d7206e37adbb94468c03e1a9}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga71b28ef0d7206e37adbb94468c03e1a9}{hwloc\+\_\+bitmap\+\_\+taskset\+\_\+sscanf} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, const char $\ast$\+\_\+\+\_\+hwloc\+\_\+restrict string)}\label{group__hwlocality__bitmap_ga71b28ef0d7206e37adbb94468c03e1a9}

\begin{DoxyCompactList}\small\item\em Parse a taskset-\/specific bitmap string and stores it in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga6c540b9fe63b8223b6aba46d56dd63b8}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga6c540b9fe63b8223b6aba46d56dd63b8}{hwloc\+\_\+bitmap\+\_\+zero} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_ga6c540b9fe63b8223b6aba46d56dd63b8}

\begin{DoxyCompactList}\small\item\em Empty the bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga52456f7ef79d68e610cb65e3f7ffafad}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga52456f7ef79d68e610cb65e3f7ffafad}{hwloc\+\_\+bitmap\+\_\+fill} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_ga52456f7ef79d68e610cb65e3f7ffafad}

\begin{DoxyCompactList}\small\item\em Fill bitmap {\ttfamily bitmap} with all possible indexes (even if those objects don't exist or are otherwise unavailable) \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga8ea10f5ebaadb8418f28f953d6106190}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga8ea10f5ebaadb8418f28f953d6106190}{hwloc\+\_\+bitmap\+\_\+only} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned id)}\label{group__hwlocality__bitmap_ga8ea10f5ebaadb8418f28f953d6106190}

\begin{DoxyCompactList}\small\item\em Empty the bitmap {\ttfamily bitmap} and add bit {\ttfamily id}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga88204c1c313aa067da10241b5886a166}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga88204c1c313aa067da10241b5886a166}{hwloc\+\_\+bitmap\+\_\+allbut} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned id)}\label{group__hwlocality__bitmap_ga88204c1c313aa067da10241b5886a166}

\begin{DoxyCompactList}\small\item\em Fill the bitmap {\ttfamily and} clear the index {\ttfamily id}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga02eae57cff32b6aa55044e6609ae7d73}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga02eae57cff32b6aa55044e6609ae7d73}{hwloc\+\_\+bitmap\+\_\+from\+\_\+ulong} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned long mask)}\label{group__hwlocality__bitmap_ga02eae57cff32b6aa55044e6609ae7d73}

\begin{DoxyCompactList}\small\item\em Setup bitmap {\ttfamily bitmap} from unsigned long {\ttfamily mask}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga3c44c943cb3a3e4577b32d924e4f36f2}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga3c44c943cb3a3e4577b32d924e4f36f2}{hwloc\+\_\+bitmap\+\_\+from\+\_\+ith\+\_\+ulong} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned i, unsigned long mask)}\label{group__hwlocality__bitmap_ga3c44c943cb3a3e4577b32d924e4f36f2}

\begin{DoxyCompactList}\small\item\em Setup bitmap {\ttfamily bitmap} from unsigned long {\ttfamily mask} used as {\ttfamily i} -\/th subset. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga497556af0cc34f109ae0277999c074d3}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga497556af0cc34f109ae0277999c074d3}{hwloc\+\_\+bitmap\+\_\+set} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned id)}\label{group__hwlocality__bitmap_ga497556af0cc34f109ae0277999c074d3}

\begin{DoxyCompactList}\small\item\em Add index {\ttfamily id} in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga9d4f8fc40f552a76c943b5b773ac17d6}{hwloc\+\_\+bitmap\+\_\+set\+\_\+range} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned begin, int end)
\begin{DoxyCompactList}\small\item\em Add indexes from {\ttfamily begin} to {\ttfamily end} in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga56027d6b141a3da441925e6e999de1c1}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga56027d6b141a3da441925e6e999de1c1}{hwloc\+\_\+bitmap\+\_\+set\+\_\+ith\+\_\+ulong} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned i, unsigned long mask)}\label{group__hwlocality__bitmap_ga56027d6b141a3da441925e6e999de1c1}

\begin{DoxyCompactList}\small\item\em Replace {\ttfamily i} -\/th subset of bitmap {\ttfamily bitmap} with unsigned long {\ttfamily mask}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga54e89b87ba5f5c18323f16690e0e5730}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga54e89b87ba5f5c18323f16690e0e5730}{hwloc\+\_\+bitmap\+\_\+clr} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned id)}\label{group__hwlocality__bitmap_ga54e89b87ba5f5c18323f16690e0e5730}

\begin{DoxyCompactList}\small\item\em Remove index {\ttfamily id} from bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_gac27bd46fd5b387def6b40712b7ee2796}{hwloc\+\_\+bitmap\+\_\+clr\+\_\+range} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap, unsigned begin, int end)
\begin{DoxyCompactList}\small\item\em Remove indexes from {\ttfamily begin} to {\ttfamily end} in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga4630aa1b7e08eac5b41be126194e84a1}{hwloc\+\_\+bitmap\+\_\+singlify} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} bitmap)
\begin{DoxyCompactList}\small\item\em Keep a single index among those set in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga4fee4e3cea99e4a389c54a6c3f0c78ed}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C unsigned long \hyperlink{group__hwlocality__bitmap_ga4fee4e3cea99e4a389c54a6c3f0c78ed}{hwloc\+\_\+bitmap\+\_\+to\+\_\+ulong} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_ga4fee4e3cea99e4a389c54a6c3f0c78ed}

\begin{DoxyCompactList}\small\item\em Convert the beginning part of bitmap {\ttfamily bitmap} into unsigned long {\ttfamily mask}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gabc0b9f4cae56a1303c38b2380086efc2}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C unsigned long \hyperlink{group__hwlocality__bitmap_gabc0b9f4cae56a1303c38b2380086efc2}{hwloc\+\_\+bitmap\+\_\+to\+\_\+ith\+\_\+ulong} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap, unsigned i) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_gabc0b9f4cae56a1303c38b2380086efc2}

\begin{DoxyCompactList}\small\item\em Convert the {\ttfamily i} -\/th subset of bitmap {\ttfamily bitmap} into unsigned long mask. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga2583f44cbdb5fff2ea40efdcf3975d3f}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga2583f44cbdb5fff2ea40efdcf3975d3f}{hwloc\+\_\+bitmap\+\_\+isset} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap, unsigned id) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_ga2583f44cbdb5fff2ea40efdcf3975d3f}

\begin{DoxyCompactList}\small\item\em Test whether index {\ttfamily id} is part of bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gaa94fed35d2a598bc4a8657b6955b7bf5}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gaa94fed35d2a598bc4a8657b6955b7bf5}{hwloc\+\_\+bitmap\+\_\+iszero} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_gaa94fed35d2a598bc4a8657b6955b7bf5}

\begin{DoxyCompactList}\small\item\em Test whether bitmap {\ttfamily bitmap} is empty. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga59a07ecd8e74f2d4ee4271a1dbf0e4dd}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga59a07ecd8e74f2d4ee4271a1dbf0e4dd}{hwloc\+\_\+bitmap\+\_\+isfull} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_ga59a07ecd8e74f2d4ee4271a1dbf0e4dd}

\begin{DoxyCompactList}\small\item\em Test whether bitmap {\ttfamily bitmap} is completely full. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga42472a7b75ca79cae19f0611fdb849e6}{hwloc\+\_\+bitmap\+\_\+first} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compute the first index (least significant bit) in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga00fc0b9d7d603e271b75956a7dd28826}{hwloc\+\_\+bitmap\+\_\+next} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap, int prev) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compute the next index in bitmap {\ttfamily bitmap} which is after index {\ttfamily prev}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga4d5786ea9561d9ddbf90bc0ce606c549}{hwloc\+\_\+bitmap\+\_\+last} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compute the last index (most significant bit) in bitmap {\ttfamily bitmap}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga12d520387be74f849f191d7a06ac325c}{hwloc\+\_\+bitmap\+\_\+weight} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compute the \char`\"{}weight\char`\"{} of bitmap {\ttfamily bitmap} (i.\+e., number of indexes that are in the bitmap). \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga1ba1de709ee9a7cf5cc8ad2d9a1a81d4}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga1ba1de709ee9a7cf5cc8ad2d9a1a81d4}{hwloc\+\_\+bitmap\+\_\+or} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} res, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2)}\label{group__hwlocality__bitmap_ga1ba1de709ee9a7cf5cc8ad2d9a1a81d4}

\begin{DoxyCompactList}\small\item\em Or bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} and store the result in bitmap {\ttfamily res}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gac2f7675dcf1b664a832413d9990d1bcf}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_gac2f7675dcf1b664a832413d9990d1bcf}{hwloc\+\_\+bitmap\+\_\+and} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} res, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2)}\label{group__hwlocality__bitmap_gac2f7675dcf1b664a832413d9990d1bcf}

\begin{DoxyCompactList}\small\item\em And bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} and store the result in bitmap {\ttfamily res}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga7618a962685d95564564ba07e9b2199b}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga7618a962685d95564564ba07e9b2199b}{hwloc\+\_\+bitmap\+\_\+andnot} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} res, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2)}\label{group__hwlocality__bitmap_ga7618a962685d95564564ba07e9b2199b}

\begin{DoxyCompactList}\small\item\em And bitmap {\ttfamily bitmap1} and the negation of {\ttfamily bitmap2} and store the result in bitmap {\ttfamily res}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga5743af61c30758df75aec29c12444616}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga5743af61c30758df75aec29c12444616}{hwloc\+\_\+bitmap\+\_\+xor} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} res, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2)}\label{group__hwlocality__bitmap_ga5743af61c30758df75aec29c12444616}

\begin{DoxyCompactList}\small\item\em Xor bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} and store the result in bitmap {\ttfamily res}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga4a8088d62755a083ffce9d592c9e3878}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{group__hwlocality__bitmap_ga4a8088d62755a083ffce9d592c9e3878}{hwloc\+\_\+bitmap\+\_\+not} (\hyperlink{group__hwlocality__bitmap_gaa3c2bf4c776d603dcebbb61b0c923d84}{hwloc\+\_\+bitmap\+\_\+t} res, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap)}\label{group__hwlocality__bitmap_ga4a8088d62755a083ffce9d592c9e3878}

\begin{DoxyCompactList}\small\item\em Negate bitmap {\ttfamily bitmap} and store the result in bitmap {\ttfamily res}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga575c27953709a8cb9a047aae65157526}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga575c27953709a8cb9a047aae65157526}{hwloc\+\_\+bitmap\+\_\+intersects} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_ga575c27953709a8cb9a047aae65157526}

\begin{DoxyCompactList}\small\item\em Test whether bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} intersects. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_gaae29e14a926c198e8f91e6e4790621e7}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gaae29e14a926c198e8f91e6e4790621e7}{hwloc\+\_\+bitmap\+\_\+isincluded} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} sub\+\_\+bitmap, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} super\+\_\+bitmap) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_gaae29e14a926c198e8f91e6e4790621e7}

\begin{DoxyCompactList}\small\item\em Test whether bitmap {\ttfamily sub\+\_\+bitmap} is part of bitmap {\ttfamily super\+\_\+bitmap}. \end{DoxyCompactList}\item 
\hypertarget{group__hwlocality__bitmap_ga4dd6a75ab63d33ef33bd626b0e489388}{H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_ga4dd6a75ab63d33ef33bd626b0e489388}{hwloc\+\_\+bitmap\+\_\+isequal} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure}\label{group__hwlocality__bitmap_ga4dd6a75ab63d33ef33bd626b0e489388}

\begin{DoxyCompactList}\small\item\em Test whether bitmap {\ttfamily bitmap1} is equal to bitmap {\ttfamily bitmap2}. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gac1cbd1e03f9986552243761e657e1752}{hwloc\+\_\+bitmap\+\_\+compare\+\_\+first} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compare bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} using their lowest index. \end{DoxyCompactList}\item 
H\+W\+L\+O\+C\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{group__hwlocality__bitmap_gadd3aa325f2d6a17b5aa3b3be9c740da0}{hwloc\+\_\+bitmap\+\_\+compare} (\hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap1, \hyperlink{group__hwlocality__bitmap_gae991a108af01d408be2776c5b2c467b2}{hwloc\+\_\+const\+\_\+bitmap\+\_\+t} bitmap2) \+\_\+\+\_\+hwloc\+\_\+attribute\+\_\+pure
\begin{DoxyCompactList}\small\item\em Compare bitmaps {\ttfamily bitmap1} and {\ttfamily bitmap2} using their highest index. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
The bitmap A\+P\+I, for use in hwloc itself. 

