\hypertarget{a00307}{
\section{mln::p\_\-image$<$ I $>$ Class Template Reference}
\label{d0/da2/a00307}\index{mln::p\_\-image@{mln::p\_\-image}}
}


\hyperlink{a00343}{Site} set based on an image of Booleans.  




{\ttfamily \#include $<$p\_\-image.hh$>$}



Inherits site\_\-set\_\-base\_\-$<$ I::psite, p\_\-image$<$ I $>$ $>$.

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \hyperlink{a00306_a355b80cd87d7256d7d5af55c38749e52}{S::bkd\_\-piter} \hyperlink{a00307_abab480b80a960ea45bb79a1d68922495}{bkd\_\-piter}
\begin{DoxyCompactList}\small\item\em Backward \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef I::psite \hyperlink{a00307_a6714cae86989ac8bef9c61484870c9bd}{element}
\begin{DoxyCompactList}\small\item\em Element associated type. \item\end{DoxyCompactList}\item 
typedef \hyperlink{a00306_ac2ac6a3656baeb8a74ebcace64659348}{S::fwd\_\-piter} \hyperlink{a00307_ac1b37f71c551dea9ff6b31fb59b3f598}{fwd\_\-piter}
\begin{DoxyCompactList}\small\item\em Forward \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \hyperlink{a00307_aa3142ef3e23d0db0c85c7cdbfaa6e193}{i\_\-element}
\begin{DoxyCompactList}\small\item\em Insertion element associated type. \item\end{DoxyCompactList}\item 
typedef \hyperlink{a00306_a6ea6e0d356a88a5311d53e7e7c6358a3}{S::piter} \hyperlink{a00307_ad3ac22a1694f1fb3f28da78925d3a631}{piter}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef I::psite \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite}
\begin{DoxyCompactList}\small\item\em Psite associated type. \item\end{DoxyCompactList}\item 
typedef \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \hyperlink{a00307_a34e9f49aa17e23fb46b914389a7a8748}{r\_\-element}
\begin{DoxyCompactList}\small\item\em Removal element associated type. \item\end{DoxyCompactList}\item 
typedef internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret \hyperlink{a00307_a51a40516976787a0cd01c81eb4d3128c}{S}
\begin{DoxyCompactList}\small\item\em Equivalent site\_\-set type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{a00307_a1c2c7153e3782cd727493dd155c22a93}{clear} ()
\begin{DoxyCompactList}\small\item\em Clear this set. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00307_a4ca2d524fb8efccf982d6323c1b37a95}{has} (const \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \&) const 
\begin{DoxyCompactList}\small\item\em Test is the psite {\ttfamily p} belongs to this site set. \item\end{DoxyCompactList}\item 
void \hyperlink{a00307_a948faf5936a500703a3e07f52e7cee68}{insert} (const \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \&p)
\begin{DoxyCompactList}\small\item\em Insert a site {\ttfamily p}. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00307_ac867b53f6c8f39007872dda649b99ad3}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Test if this site set is valid, i.e., initialized. \item\end{DoxyCompactList}\item 
std::size\_\-t \hyperlink{a00307_a92a7a859f9b96d8f708f38709c986490}{memory\_\-size} () const 
\begin{DoxyCompactList}\small\item\em Return the size of this site set in memory. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00307_ace7dad54cdbaa71b0470eb5b5c518086}{nsites} () const 
\begin{DoxyCompactList}\small\item\em Give the number of sites. \item\end{DoxyCompactList}\item 
\hyperlink{a00307_ab8dd14172f99b31f7fe14b3628d4916b}{operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret} () const 
\begin{DoxyCompactList}\small\item\em Conversion towards the equivalent site set. \item\end{DoxyCompactList}\item 
\hyperlink{a00307_aeb75f81ba8160fa789dbba1ab7bde75c}{p\_\-image} ()
\begin{DoxyCompactList}\small\item\em Constructor without argument. \item\end{DoxyCompactList}\item 
\hyperlink{a00307_a26fe1717c0087065c3fe0c8189a4d7b6}{p\_\-image} (const I \&ima)
\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\item 
void \hyperlink{a00307_ab484366716ef24b98a33dee9582d9c95}{remove} (const \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \&p)
\begin{DoxyCompactList}\small\item\em Remove a site {\ttfamily p}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00307_a33b442f0d7aee515adcb4c6f30ed09e9}{toggle} (const \hyperlink{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{psite} \&p)
\begin{DoxyCompactList}\small\item\em Change the status in/out of a site {\ttfamily p}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename I$>$ class mln::p\_\-image$<$ I $>$}

\hyperlink{a00343}{Site} set based on an image of Booleans. 

Definition at line 88 of file p\_\-image.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00307_abab480b80a960ea45bb79a1d68922495}{
\index{mln::p\_\-image@{mln::p\_\-image}!bkd\_\-piter@{bkd\_\-piter}}
\index{bkd\_\-piter@{bkd\_\-piter}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{bkd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef {\bf S} ::{\bf bkd\_\-piter} {\bf mln::p\_\-image}$<$ I $>$::{\bf bkd\_\-piter}}}
\label{d0/da2/a00307_abab480b80a960ea45bb79a1d68922495}


Backward \hyperlink{a00345}{Site\_\-Iterator} associated type. 



Definition at line 110 of file p\_\-image.hh.

\hypertarget{a00307_a6714cae86989ac8bef9c61484870c9bd}{
\index{mln::p\_\-image@{mln::p\_\-image}!element@{element}}
\index{element@{element}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef I ::{\bf psite} {\bf mln::p\_\-image}$<$ I $>$::{\bf element}}}
\label{d0/da2/a00307_a6714cae86989ac8bef9c61484870c9bd}


Element associated type. 



Definition at line 100 of file p\_\-image.hh.

\hypertarget{a00307_ac1b37f71c551dea9ff6b31fb59b3f598}{
\index{mln::p\_\-image@{mln::p\_\-image}!fwd\_\-piter@{fwd\_\-piter}}
\index{fwd\_\-piter@{fwd\_\-piter}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{fwd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef {\bf S} ::{\bf fwd\_\-piter} {\bf mln::p\_\-image}$<$ I $>$::{\bf fwd\_\-piter}}}
\label{d0/da2/a00307_ac1b37f71c551dea9ff6b31fb59b3f598}


Forward \hyperlink{a00345}{Site\_\-Iterator} associated type. 



Definition at line 107 of file p\_\-image.hh.

\hypertarget{a00307_aa3142ef3e23d0db0c85c7cdbfaa6e193}{
\index{mln::p\_\-image@{mln::p\_\-image}!i\_\-element@{i\_\-element}}
\index{i\_\-element@{i\_\-element}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{i\_\-element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef {\bf psite} {\bf mln::p\_\-image}$<$ I $>$::{\bf i\_\-element}}}
\label{d0/da2/a00307_aa3142ef3e23d0db0c85c7cdbfaa6e193}


Insertion element associated type. 



Definition at line 136 of file p\_\-image.hh.

\hypertarget{a00307_ad3ac22a1694f1fb3f28da78925d3a631}{
\index{mln::p\_\-image@{mln::p\_\-image}!piter@{piter}}
\index{piter@{piter}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef {\bf S} ::{\bf piter} {\bf mln::p\_\-image}$<$ I $>$::{\bf piter}}}
\label{d0/da2/a00307_ad3ac22a1694f1fb3f28da78925d3a631}


\hyperlink{a00345}{Site\_\-Iterator} associated type. 



Definition at line 113 of file p\_\-image.hh.

\hypertarget{a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}{
\index{mln::p\_\-image@{mln::p\_\-image}!psite@{psite}}
\index{psite@{psite}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{psite}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef I ::{\bf psite} {\bf mln::p\_\-image}$<$ I $>$::{\bf psite}}}
\label{d0/da2/a00307_ac9a66be6f9e07e7dd5c603ee3c7cf25a}


Psite associated type. 



Definition at line 104 of file p\_\-image.hh.

\hypertarget{a00307_a34e9f49aa17e23fb46b914389a7a8748}{
\index{mln::p\_\-image@{mln::p\_\-image}!r\_\-element@{r\_\-element}}
\index{r\_\-element@{r\_\-element}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{r\_\-element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef {\bf psite} {\bf mln::p\_\-image}$<$ I $>$::{\bf r\_\-element}}}
\label{d0/da2/a00307_a34e9f49aa17e23fb46b914389a7a8748}


Removal element associated type. 



Definition at line 142 of file p\_\-image.hh.

\hypertarget{a00307_a51a40516976787a0cd01c81eb4d3128c}{
\index{mln::p\_\-image@{mln::p\_\-image}!S@{S}}
\index{S@{S}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{S}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ typedef internal::p\_\-image\_\-site\_\-set$<$I$>$::ret {\bf mln::p\_\-image}$<$ I $>$::{\bf S}}}
\label{d0/da2/a00307_a51a40516976787a0cd01c81eb4d3128c}


Equivalent site\_\-set type. 



Definition at line 93 of file p\_\-image.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00307_aeb75f81ba8160fa789dbba1ab7bde75c}{
\index{mln::p\_\-image@{mln::p\_\-image}!p\_\-image@{p\_\-image}}
\index{p\_\-image@{p\_\-image}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{p\_\-image}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ {\bf mln::p\_\-image}$<$ I $>$::{\bf p\_\-image} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_aeb75f81ba8160fa789dbba1ab7bde75c}


Constructor without argument. 



Definition at line 182 of file p\_\-image.hh.

\hypertarget{a00307_a26fe1717c0087065c3fe0c8189a4d7b6}{
\index{mln::p\_\-image@{mln::p\_\-image}!p\_\-image@{p\_\-image}}
\index{p\_\-image@{p\_\-image}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{p\_\-image}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ {\bf mln::p\_\-image}$<$ I $>$::{\bf p\_\-image} (
\begin{DoxyParamCaption}
\item[{const I \&}]{ ima}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a26fe1717c0087065c3fe0c8189a4d7b6}


Constructor. 



Definition at line 189 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::clear().



\subsection{Member Function Documentation}
\hypertarget{a00307_a1c2c7153e3782cd727493dd155c22a93}{
\index{mln::p\_\-image@{mln::p\_\-image}!clear@{clear}}
\index{clear@{clear}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{clear}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ void {\bf mln::p\_\-image}$<$ I $>$::clear (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a1c2c7153e3782cd727493dd155c22a93}


Clear this set. 



Definition at line 283 of file p\_\-image.hh.



References mln::data::fill\_\-with\_\-value(), and mln::p\_\-image$<$ I $>$::is\_\-valid().



Referenced by mln::p\_\-image$<$ I $>$::p\_\-image().

\hypertarget{a00307_a4ca2d524fb8efccf982d6323c1b37a95}{
\index{mln::p\_\-image@{mln::p\_\-image}!has@{has}}
\index{has@{has}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ bool {\bf mln::p\_\-image}$<$ I $>$::has (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a4ca2d524fb8efccf982d6323c1b37a95}


Test is the psite {\ttfamily p} belongs to this site set. 



Definition at line 199 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::is\_\-valid().

\hypertarget{a00307_a948faf5936a500703a3e07f52e7cee68}{
\index{mln::p\_\-image@{mln::p\_\-image}!insert@{insert}}
\index{insert@{insert}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{insert}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ void {\bf mln::p\_\-image}$<$ I $>$::insert (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a948faf5936a500703a3e07f52e7cee68}


Insert a site {\ttfamily p}. 



Definition at line 224 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::is\_\-valid().

\hypertarget{a00307_ac867b53f6c8f39007872dda649b99ad3}{
\index{mln::p\_\-image@{mln::p\_\-image}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ bool {\bf mln::p\_\-image}$<$ I $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_ac867b53f6c8f39007872dda649b99ad3}


Test if this site set is valid, i.e., initialized. 



Definition at line 208 of file p\_\-image.hh.



Referenced by mln::p\_\-image$<$ I $>$::clear(), mln::p\_\-image$<$ I $>$::has(), mln::p\_\-image$<$ I $>$::insert(), mln::p\_\-image$<$ I $>$::memory\_\-size(), mln::p\_\-image$<$ I $>$::remove(), and mln::p\_\-image$<$ I $>$::toggle().

\hypertarget{a00307_a92a7a859f9b96d8f708f38709c986490}{
\index{mln::p\_\-image@{mln::p\_\-image}!memory\_\-size@{memory\_\-size}}
\index{memory\_\-size@{memory\_\-size}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{memory\_\-size}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ std::size\_\-t {\bf mln::p\_\-image}$<$ I $>$::memory\_\-size (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a92a7a859f9b96d8f708f38709c986490}


Return the size of this site set in memory. 



Definition at line 273 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::is\_\-valid().

\hypertarget{a00307_ace7dad54cdbaa71b0470eb5b5c518086}{
\index{mln::p\_\-image@{mln::p\_\-image}!nsites@{nsites}}
\index{nsites@{nsites}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{nsites}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ unsigned {\bf mln::p\_\-image}$<$ I $>$::nsites (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_ace7dad54cdbaa71b0470eb5b5c518086}


Give the number of sites. 



Definition at line 216 of file p\_\-image.hh.

\hypertarget{a00307_ab8dd14172f99b31f7fe14b3628d4916b}{
\index{mln::p\_\-image@{mln::p\_\-image}!operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret@{operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret}}
\index{operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret@{operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ {\bf mln::p\_\-image}$<$ I $>$::operator typename internal::p\_\-image\_\-site\_\-set$<$ I $>$::ret (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_ab8dd14172f99b31f7fe14b3628d4916b}


Conversion towards the equivalent site set. 



Definition at line 174 of file p\_\-image.hh.

\hypertarget{a00307_ab484366716ef24b98a33dee9582d9c95}{
\index{mln::p\_\-image@{mln::p\_\-image}!remove@{remove}}
\index{remove@{remove}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{remove}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ void {\bf mln::p\_\-image}$<$ I $>$::remove (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_ab484366716ef24b98a33dee9582d9c95}


Remove a site {\ttfamily p}. 



Definition at line 237 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::is\_\-valid().

\hypertarget{a00307_a33b442f0d7aee515adcb4c6f30ed09e9}{
\index{mln::p\_\-image@{mln::p\_\-image}!toggle@{toggle}}
\index{toggle@{toggle}!mln::p_image@{mln::p\_\-image}}
\subsubsection[{toggle}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename I $>$ void {\bf mln::p\_\-image}$<$ I $>$::toggle (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d0/da2/a00307_a33b442f0d7aee515adcb4c6f30ed09e9}


Change the status in/out of a site {\ttfamily p}. 



Definition at line 251 of file p\_\-image.hh.



References mln::p\_\-image$<$ I $>$::is\_\-valid().

