\hypertarget{a00161}{
\section{mln::doc::Box$<$ E $>$ Struct Template Reference}
\label{d6/d7d/a00161}\index{mln::doc::Box@{mln::doc::Box}}
}


Documentation class for \hyperlink{a00028}{mln::Box}.  




{\ttfamily \#include $<$box.hh$>$}



Inheritance diagram for mln::doc::Box$<$ E $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=212pt]{df/df7/a03776}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef void \hyperlink{a00172_a713ded9fcee165ddd2e6dc32bdbf49f1}{bkd\_\-piter}
\begin{DoxyCompactList}\small\item\em Backward \hyperlink{a00171}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00172_af750a4c29520af2178f9448bcdf2c791}{fwd\_\-piter}
\begin{DoxyCompactList}\small\item\em Forward \hyperlink{a00171}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00172_a21989de6e301e7a0a6e002c1634fbbbd}{psite}
\begin{DoxyCompactList}\small\item\em PSite associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00172_a19ba34e2c4a951bf4f780efedf7b54f8}{site}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00343}{Site} associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const E \& \hyperlink{a00161_a9c04d694c7568dacba81bbda8d95af78}{bbox} () const 
\begin{DoxyCompactList}\small\item\em Return the bounding box of this point set. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00172_a5185a518728730ac85e74e9fdf4a11b8}{has} (const \hyperlink{a00172_a21989de6e301e7a0a6e002c1634fbbbd}{psite} \&p) const 
\begin{DoxyCompactList}\small\item\em Test if {\ttfamily p} belongs to this site set. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00161_a989990c9a5e17cda380ac1247caaa08b}{nsites} () const 
\begin{DoxyCompactList}\small\item\em Return the number of points of this box. \item\end{DoxyCompactList}\item 
const \hyperlink{a00172_a19ba34e2c4a951bf4f780efedf7b54f8}{site} \& \hyperlink{a00161_a0796c5a050e3e228c67e33a88a49a7f4}{pmax} () const 
\begin{DoxyCompactList}\small\item\em Give the box \char`\"{}maximum\char`\"{} point. \item\end{DoxyCompactList}\item 
const \hyperlink{a00172_a19ba34e2c4a951bf4f780efedf7b54f8}{site} \& \hyperlink{a00161_a5fecb9a3041f678c9be71a483ba78cec}{pmin} () const 
\begin{DoxyCompactList}\small\item\em Give the box \char`\"{}minimum\char`\"{} point. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename E$>$ struct mln::doc::Box$<$ E $>$}

Documentation class for \hyperlink{a00028}{mln::Box}. \begin{DoxySeeAlso}{See also}
\hyperlink{a00028}{mln::Box} 
\end{DoxySeeAlso}


Definition at line 36 of file core/concept/doc/box.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00172_a713ded9fcee165ddd2e6dc32bdbf49f1}{
\index{mln::doc::Box@{mln::doc::Box}!bkd\_\-piter@{bkd\_\-piter}}
\index{bkd\_\-piter@{bkd\_\-piter}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{bkd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Site\_\-Set}$<$ E $>$::{\bf bkd\_\-piter}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/dfb/a00172_a713ded9fcee165ddd2e6dc32bdbf49f1}


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



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

\hypertarget{a00172_af750a4c29520af2178f9448bcdf2c791}{
\index{mln::doc::Box@{mln::doc::Box}!fwd\_\-piter@{fwd\_\-piter}}
\index{fwd\_\-piter@{fwd\_\-piter}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{fwd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Site\_\-Set}$<$ E $>$::{\bf fwd\_\-piter}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/dfb/a00172_af750a4c29520af2178f9448bcdf2c791}


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



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

\hypertarget{a00172_a21989de6e301e7a0a6e002c1634fbbbd}{
\index{mln::doc::Box@{mln::doc::Box}!psite@{psite}}
\index{psite@{psite}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{psite}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Site\_\-Set}$<$ E $>$::{\bf psite}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/dfb/a00172_a21989de6e301e7a0a6e002c1634fbbbd}


PSite associated type. 



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

\hypertarget{a00172_a19ba34e2c4a951bf4f780efedf7b54f8}{
\index{mln::doc::Box@{mln::doc::Box}!site@{site}}
\index{site@{site}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{site}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Site\_\-Set}$<$ E $>$::{\bf site}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/dfb/a00172_a19ba34e2c4a951bf4f780efedf7b54f8}


\hyperlink{a00343}{Site} associated type. 



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



\subsection{Member Function Documentation}
\hypertarget{a00161_a9c04d694c7568dacba81bbda8d95af78}{
\index{mln::doc::Box@{mln::doc::Box}!bbox@{bbox}}
\index{bbox@{bbox}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{bbox}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const E\& {\bf mln::doc::Box}$<$ E $>$::bbox (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d6/d7d/a00161_a9c04d694c7568dacba81bbda8d95af78}


Return the bounding box of this point set. 

Return the bounding box of this point set, so that is itself. This method is declared by the \hyperlink{a00348}{mln::Site\_\-Set} concept.

\begin{DoxyWarning}{Warning}
This method is final for all box classes. 
\end{DoxyWarning}
\hypertarget{a00172_a5185a518728730ac85e74e9fdf4a11b8}{
\index{mln::doc::Box@{mln::doc::Box}!has@{has}}
\index{has@{has}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Site\_\-Set}$<$ E $>$::has (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d6/dfb/a00172_a5185a518728730ac85e74e9fdf4a11b8}


Test if {\ttfamily p} belongs to this site set. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em p}]A psite. \end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if {\ttfamily p} is an element of the site set. 
\end{DoxyReturn}
\hypertarget{a00161_a989990c9a5e17cda380ac1247caaa08b}{
\index{mln::doc::Box@{mln::doc::Box}!nsites@{nsites}}
\index{nsites@{nsites}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{nsites}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ unsigned {\bf mln::doc::Box}$<$ E $>$::nsites (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d6/d7d/a00161_a989990c9a5e17cda380ac1247caaa08b}


Return the number of points of this box. 

Return the number of points of this box. This method is declared by the \hyperlink{a00348}{mln::Site\_\-Set} concept.

\begin{DoxyWarning}{Warning}
This method is final for all box classes. 
\end{DoxyWarning}
\hypertarget{a00161_a0796c5a050e3e228c67e33a88a49a7f4}{
\index{mln::doc::Box@{mln::doc::Box}!pmax@{pmax}}
\index{pmax@{pmax}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{pmax}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf site}\& {\bf mln::doc::Box}$<$ E $>$::pmax (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d6/d7d/a00161_a0796c5a050e3e228c67e33a88a49a7f4}


Give the box \char`\"{}maximum\char`\"{} point. 

Return the \char`\"{}maximum\char`\"{} point w.r.t. the ordering between points. For instance, with \hyperlink{a01799_a944afc8b3385351cb593d3a4841094fa}{mln::box2d}, this maximum is the bottom right point of the box. \hypertarget{a00161_a5fecb9a3041f678c9be71a483ba78cec}{
\index{mln::doc::Box@{mln::doc::Box}!pmin@{pmin}}
\index{pmin@{pmin}!mln::doc::Box@{mln::doc::Box}}
\subsubsection[{pmin}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf site}\& {\bf mln::doc::Box}$<$ E $>$::pmin (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d6/d7d/a00161_a5fecb9a3041f678c9be71a483ba78cec}


Give the box \char`\"{}minimum\char`\"{} point. 

Return the \char`\"{}minimum\char`\"{} point w.r.t. the ordering between points. For instance, with \hyperlink{a01799_a944afc8b3385351cb593d3a4841094fa}{mln::box2d}, this minimum is the top left point of the box. 