\hypertarget{a00348}{
\section{mln::Site\_\-Set$<$ E $>$ Struct Template Reference}
\label{df/d03/a00348}\index{mln::Site\_\-Set@{mln::Site\_\-Set}}
}


Base class for implementation classes of site sets.  




{\ttfamily \#include $<$site\_\-set.hh$>$}



Inheritance diagram for mln::Site\_\-Set$<$ E $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{d1/d43/a03612}
\end{center}
\end{figure}
\subsection*{Related Functions}
(Note that these are not member functions.) \begin{DoxyCompactItemize}
\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\\hyperlink{a00320}{p\_\-set}$<$ typename Sl::site $>$ \hyperlink{a00348_a209946459ef9fbcf7a827f1b153867f0}{diff} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Set theoretic difference of {\ttfamily lhs} and {\ttfamily rhs}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\\hyperlink{a00320}{p\_\-set}$<$ typename Sl::site $>$ \hyperlink{a00348_ac8f40def1143ff1f29363ebfed8a090c}{inter} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Intersection between a couple of point sets. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\bool \hyperlink{a00348_a9c1c89a74e9e424f1eb8cb3a01b1c2e0}{operator$<$} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Strict inclusion test between site sets {\ttfamily lhs} and {\ttfamily rhs}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename S $>$ }\\std::ostream \& \hyperlink{a00348_a44002127b8ae83b633cc1cceca9d5baa}{operator$<$$<$} (std::ostream \&ostr, const \hyperlink{a00348}{Site\_\-Set}$<$ S $>$ \&\hyperlink{a00432}{set})
\begin{DoxyCompactList}\small\item\em Print a site set {\ttfamily set} into the output stream {\ttfamily ostr}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\bool \hyperlink{a00348_a864fd47cfb0a45b9403e21fab42067d5}{operator$<$=} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Inclusion test between site sets {\ttfamily lhs} and {\ttfamily rhs}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\bool \hyperlink{a00348_a2aaedfe17e98d6670ed57c8102eb7749}{operator==} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Equality test between site sets {\ttfamily lhs} and {\ttfamily rhs}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\\hyperlink{a00320}{p\_\-set}$<$ typename Sl::site $>$ \hyperlink{a00348_a2d114751ea5c8622f744dada103483cb}{sym\_\-diff} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Set theoretic symmetrical difference of {\ttfamily lhs} and {\ttfamily rhs}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Sl , typename Sr $>$ }\\\hyperlink{a00320}{p\_\-set}$<$ typename Sl::site $>$ \hyperlink{a00348_a2cc83fbbb290d98bdbbf8027750e4ef8}{uni} (const \hyperlink{a00348}{Site\_\-Set}$<$ Sl $>$ \&lhs, const \hyperlink{a00348}{Site\_\-Set}$<$ Sr $>$ \&rhs)
\begin{DoxyCompactList}\small\item\em Union of a couple of point sets. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename S $>$ }\\\hyperlink{a00320}{p\_\-set}$<$ typename S::site $>$ \hyperlink{a00348_a5acca096453b76ee0eeb919ac248165b}{unique} (const \hyperlink{a00348}{Site\_\-Set}$<$ S $>$ \&s)
\begin{DoxyCompactList}\small\item\em Give the unique set of {\ttfamily s}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename E$>$ struct mln::Site\_\-Set$<$ E $>$}

Base class for implementation classes of site sets. \begin{DoxySeeAlso}{See also}
\hyperlink{a00172}{mln::doc::Site\_\-Set} for a complete documentation of this class contents. 
\end{DoxySeeAlso}


Definition at line 65 of file mln/core/concept/site\_\-set.hh.



\subsection{Friends And Related Function Documentation}
\hypertarget{a00348_a209946459ef9fbcf7a827f1b153867f0}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!diff@{diff}}
\index{diff@{diff}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{diff}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ {\bf p\_\-set}$<$ typename Sl::site $>$ diff (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a209946459ef9fbcf7a827f1b153867f0}


Set theoretic difference of {\ttfamily lhs} and {\ttfamily rhs}. 



Definition at line 66 of file set/diff.hh.

\hypertarget{a00348_ac8f40def1143ff1f29363ebfed8a090c}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!inter@{inter}}
\index{inter@{inter}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{inter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ {\bf p\_\-set}$<$ typename Sl::site $>$ inter (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_ac8f40def1143ff1f29363ebfed8a090c}


Intersection between a couple of point sets. 



Definition at line 62 of file set/inter.hh.

\hypertarget{a00348_a9c1c89a74e9e424f1eb8cb3a01b1c2e0}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!operator$<$@{operator$<$}}
\index{operator$<$@{operator$<$}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{operator$<$}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ bool operator$<$ (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a9c1c89a74e9e424f1eb8cb3a01b1c2e0}


Strict inclusion test between site sets {\ttfamily lhs} and {\ttfamily rhs}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em lhs}]A site set (strictly included?). \item[\mbox{\tt[in]} {\em rhs}]Another site set (includer?). \end{DoxyParams}


Definition at line 479 of file operators.hh.

\hypertarget{a00348_a44002127b8ae83b633cc1cceca9d5baa}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!operator$<$$<$@{operator$<$$<$}}
\index{operator$<$$<$@{operator$<$$<$}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{operator$<$$<$}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S $>$ std::ostream \& operator$<$$<$ (
\begin{DoxyParamCaption}
\item[{std::ostream \&}]{ ostr, }
\item[{const {\bf Site\_\-Set}$<$ S $>$ \&}]{ set}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a44002127b8ae83b633cc1cceca9d5baa}


Print a site set {\ttfamily set} into the output stream {\ttfamily ostr}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in,out]} {\em ostr}]An output stream. \item[\mbox{\tt[in]} {\em set}]A site set.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The modified output stream {\ttfamily ostr}. 
\end{DoxyReturn}


Definition at line 505 of file operators.hh.

\hypertarget{a00348_a864fd47cfb0a45b9403e21fab42067d5}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!operator$<$=@{operator$<$=}}
\index{operator$<$=@{operator$<$=}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{operator$<$=}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ bool operator$<$= (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a864fd47cfb0a45b9403e21fab42067d5}


Inclusion test between site sets {\ttfamily lhs} and {\ttfamily rhs}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em lhs}]A site set (included?). \item[\mbox{\tt[in]} {\em rhs}]Another site set (includer?). \end{DoxyParams}


Definition at line 491 of file operators.hh.

\hypertarget{a00348_a2aaedfe17e98d6670ed57c8102eb7749}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!operator==@{operator==}}
\index{operator==@{operator==}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ bool operator== (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a2aaedfe17e98d6670ed57c8102eb7749}


Equality test between site sets {\ttfamily lhs} and {\ttfamily rhs}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em lhs}]A site set. \item[\mbox{\tt[in]} {\em rhs}]Another site set. \end{DoxyParams}


Definition at line 467 of file operators.hh.

\hypertarget{a00348_a2d114751ea5c8622f744dada103483cb}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!sym\_\-diff@{sym\_\-diff}}
\index{sym\_\-diff@{sym\_\-diff}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{sym\_\-diff}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ {\bf p\_\-set}$<$ typename Sl::site $>$ sym\_\-diff (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a2d114751ea5c8622f744dada103483cb}


Set theoretic symmetrical difference of {\ttfamily lhs} and {\ttfamily rhs}. 



Definition at line 65 of file sym\_\-diff.hh.

\hypertarget{a00348_a2cc83fbbb290d98bdbbf8027750e4ef8}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!uni@{uni}}
\index{uni@{uni}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{uni}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Sl , typename Sr $>$ {\bf p\_\-set}$<$ typename Sl::site $>$ uni (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ Sl $>$ \&}]{ lhs, }
\item[{const {\bf Site\_\-Set}$<$ Sr $>$ \&}]{ rhs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a2cc83fbbb290d98bdbbf8027750e4ef8}


Union of a couple of point sets. 



Definition at line 61 of file uni.hh.

\hypertarget{a00348_a5acca096453b76ee0eeb919ac248165b}{
\index{mln::Site\_\-Set@{mln::Site\_\-Set}!unique@{unique}}
\index{unique@{unique}!mln::Site_Set@{mln::Site\_\-Set}}
\subsubsection[{unique}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S $>$ {\bf p\_\-set}$<$ typename S::site $>$ unique (
\begin{DoxyParamCaption}
\item[{const {\bf Site\_\-Set}$<$ S $>$ \&}]{ s}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{df/d03/a00348_a5acca096453b76ee0eeb919ac248165b}


Give the unique set of {\ttfamily s}. 



Definition at line 61 of file unique.hh.

