\hypertarget{a00135}{
\section{mln::box$<$ P $>$ Class Template Reference}
\label{d5/d5b/a00135}\index{mln::box@{mln::box}}
}


Generic box class: site set containing points of a regular grid.  




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



Inheritance diagram for mln::box$<$ P $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=348pt]{dd/ddc/a03444}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum 
\begin{DoxyCompactList}\small\item\em Dimension. \item\end{DoxyCompactList}\item 
typedef box\_\-bkd\_\-piter\_\-$<$ P $>$ \hyperlink{a00135_a614dd2cb2d2c3fea0efa4239bc8d896f}{bkd\_\-piter}
\begin{DoxyCompactList}\small\item\em Backward \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef P \hyperlink{a00135_ac1cdb149ac64e6231d85ad4e1605239c}{element}
\begin{DoxyCompactList}\small\item\em Element associated type. \item\end{DoxyCompactList}\item 
typedef box\_\-fwd\_\-piter\_\-$<$ P $>$ \hyperlink{a00135_aa097ca3e9311b879798d9fb2550ba5ed}{fwd\_\-piter}
\begin{DoxyCompactList}\small\item\em Forward \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef \hyperlink{a00135_aa097ca3e9311b879798d9fb2550ba5ed}{fwd\_\-piter} \hyperlink{a00135_a194e12e745e127ac25df41b35c834d9e}{piter}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00345}{Site\_\-Iterator} associated type. \item\end{DoxyCompactList}\item 
typedef P \hyperlink{a00135_a9f52242e490cfcb9704fc0b5dd5ad28b}{psite}
\begin{DoxyCompactList}\small\item\em Psite associated type. \item\end{DoxyCompactList}\item 
typedef P \hyperlink{a00135_aa5454ad4ebd3b1c365fd93f3da99ce7c}{site}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00343}{Site} associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const \hyperlink{a00135}{box}$<$ P $>$ \& \hyperlink{a00028_a689abe6596bfbe40fa307fc0db3a9290}{bbox} () const
\begin{DoxyCompactList}\small\item\em Give the bounding box of this site set. \item\end{DoxyCompactList}\item 
\hyperlink{a00135_a5afc222197effb30a2be579e9c912b6b}{box} ()
\begin{DoxyCompactList}\small\item\em Constructor without argument. \item\end{DoxyCompactList}\item 
\hyperlink{a00135_a54d1bae3d4afb2b108fd7eee6ab5afdb}{box} (const \hyperlink{a00135_aa5454ad4ebd3b1c365fd93f3da99ce7c}{site} \&pmin, const \hyperlink{a00135_aa5454ad4ebd3b1c365fd93f3da99ce7c}{site} \&pmax)
\begin{DoxyCompactList}\small\item\em Constructor of a box going from {\ttfamily pmin} to {\ttfamily pmax}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00135_a356d219a67cd8998ab8ab691987b1f7a}{crop\_\-wrt} (const \hyperlink{a00135}{box}$<$ P $>$ \&b)
\begin{DoxyCompactList}\small\item\em Crop this bbox in order to fit in the reference box {\ttfamily b}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00135_a17f1a7ede7c9d422167e2f5271b343dd}{enlarge} (unsigned b)
\begin{DoxyCompactList}\small\item\em Enlarge the box with a border {\ttfamily b}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00135_ac5995c9050f891a8f0fd4ff1b19f93d2}{enlarge} (unsigned dim, unsigned b)
\begin{DoxyCompactList}\small\item\em Enlarge the box with a border {\ttfamily b} for dimension {\ttfamily dim}. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00135_a5ed42357653e0e6d3deb6562dab2be34}{has} (const P \&p) const 
\begin{DoxyCompactList}\small\item\em Test if {\ttfamily p} belongs to the box. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00028_a69fd0ab844d3721589ebf9fc7fa8384f}{is\_\-empty} () const
\begin{DoxyCompactList}\small\item\em Test if this box is empty. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00135_affe43575c510bd3cecc2659a7d163f47}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Test that the box owns valid data, i.e., is initialized and with pmin being 'less-\/than' pmax. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00028_a312da6ad989593a69eccdaf01660f4d7}{len} (unsigned i) const
\begin{DoxyCompactList}\small\item\em Give the length of the {\ttfamily i-\/th} side of the box. \item\end{DoxyCompactList}\item 
std::size\_\-t \hyperlink{a00135_a835180464da876558d358f888faf7396}{memory\_\-size} () const 
\begin{DoxyCompactList}\small\item\em Return the size of this site set in memory. \item\end{DoxyCompactList}\item 
void \hyperlink{a00135_a3f6d52c2f92fb4468b72357413c0e40c}{merge} (const \hyperlink{a00135}{box}$<$ P $>$ \&b)
\begin{DoxyCompactList}\small\item\em Merge inplace with another box. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00028_a3c92d5b998f6b6faad7362fe84ff37dc}{nsites} () const
\begin{DoxyCompactList}\small\item\em Give the number of sites of this box. \item\end{DoxyCompactList}\item 
P \hyperlink{a00135_a08619d07ef44192b67e299e58502d60d}{pcenter} () const 
\begin{DoxyCompactList}\small\item\em Return the approximated central site of this box. \item\end{DoxyCompactList}\item 
P \& \hyperlink{a00135_a24a3c38f2dcfbdb37602acd91ad3a049}{pmax} ()
\begin{DoxyCompactList}\small\item\em Reference to the maximum point. \item\end{DoxyCompactList}\item 
P \hyperlink{a00135_a53cddd52fd53cfc140c983bd2e2d7be6}{pmax} () const 
\begin{DoxyCompactList}\small\item\em Maximum point. \item\end{DoxyCompactList}\item 
P \hyperlink{a00135_abffcf1d1212d36fb2ed77bcbf1aeeb43}{pmin} () const 
\begin{DoxyCompactList}\small\item\em Minimum point. \item\end{DoxyCompactList}\item 
P \& \hyperlink{a00135_ab08184645ea10b9927cc10b866f15d6b}{pmin} ()
\begin{DoxyCompactList}\small\item\em Reference to the minimum point. \item\end{DoxyCompactList}\item 
\hyperlink{a00135}{box}$<$ P $>$ \hyperlink{a00135_a2951a6b2fded350d75e5d7e2bf524116}{to\_\-larger} (unsigned b) const 
\begin{DoxyCompactList}\small\item\em Give a larger box. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
\hyperlink{a00135_a9fae3d01446ea7040d4b25a3254bbda6}{box} (typename P::coord ninds)
\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Related Functions}
(Note that these are not member functions.) \begin{DoxyCompactItemize}
\item 
{\footnotesize template$<$typename P $>$ }\\std::ostream \& \hyperlink{a00135_a4d3ea6ac1853456bf074636782343fcb}{operator$<$$<$} (std::ostream \&ostr, const \hyperlink{a00135}{box}$<$ P $>$ \&b)
\begin{DoxyCompactList}\small\item\em Print a generic box {\ttfamily b} into the output stream {\ttfamily ostr}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename P$>$ class mln::box$<$ P $>$}

Generic box class: site set containing points of a regular grid. Parameter {\ttfamily P} is the corresponding type of point. 

Definition at line 81 of file core/site\_\-set/box.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00135_a614dd2cb2d2c3fea0efa4239bc8d896f}{
\index{mln::box@{mln::box}!bkd\_\-piter@{bkd\_\-piter}}
\index{bkd\_\-piter@{bkd\_\-piter}!mln::box@{mln::box}}
\subsubsection[{bkd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef box\_\-bkd\_\-piter\_\-$<$P$>$ {\bf mln::box}$<$ P $>$::{\bf bkd\_\-piter}}}
\label{d5/d5b/a00135_a614dd2cb2d2c3fea0efa4239bc8d896f}


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



Definition at line 105 of file core/site\_\-set/box.hh.

\hypertarget{a00135_ac1cdb149ac64e6231d85ad4e1605239c}{
\index{mln::box@{mln::box}!element@{element}}
\index{element@{element}!mln::box@{mln::box}}
\subsubsection[{element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef P {\bf mln::box}$<$ P $>$::{\bf element}}}
\label{d5/d5b/a00135_ac1cdb149ac64e6231d85ad4e1605239c}


Element associated type. 



Definition at line 90 of file core/site\_\-set/box.hh.

\hypertarget{a00135_aa097ca3e9311b879798d9fb2550ba5ed}{
\index{mln::box@{mln::box}!fwd\_\-piter@{fwd\_\-piter}}
\index{fwd\_\-piter@{fwd\_\-piter}!mln::box@{mln::box}}
\subsubsection[{fwd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef box\_\-fwd\_\-piter\_\-$<$P$>$ {\bf mln::box}$<$ P $>$::{\bf fwd\_\-piter}}}
\label{d5/d5b/a00135_aa097ca3e9311b879798d9fb2550ba5ed}


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



Definition at line 99 of file core/site\_\-set/box.hh.

\hypertarget{a00135_a194e12e745e127ac25df41b35c834d9e}{
\index{mln::box@{mln::box}!piter@{piter}}
\index{piter@{piter}!mln::box@{mln::box}}
\subsubsection[{piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef {\bf fwd\_\-piter} {\bf mln::box}$<$ P $>$::{\bf piter}}}
\label{d5/d5b/a00135_a194e12e745e127ac25df41b35c834d9e}


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



Definition at line 102 of file core/site\_\-set/box.hh.

\hypertarget{a00135_a9f52242e490cfcb9704fc0b5dd5ad28b}{
\index{mln::box@{mln::box}!psite@{psite}}
\index{psite@{psite}!mln::box@{mln::box}}
\subsubsection[{psite}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef P {\bf mln::box}$<$ P $>$::{\bf psite}}}
\label{d5/d5b/a00135_a9f52242e490cfcb9704fc0b5dd5ad28b}


Psite associated type. 



Definition at line 93 of file core/site\_\-set/box.hh.

\hypertarget{a00135_aa5454ad4ebd3b1c365fd93f3da99ce7c}{
\index{mln::box@{mln::box}!site@{site}}
\index{site@{site}!mln::box@{mln::box}}
\subsubsection[{site}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ typedef P {\bf mln::box}$<$ P $>$::{\bf site}}}
\label{d5/d5b/a00135_aa5454ad4ebd3b1c365fd93f3da99ce7c}


\hyperlink{a00343}{Site} associated type. 



Definition at line 96 of file core/site\_\-set/box.hh.



\subsection{Member Enumeration Documentation}
\hypertarget{a00135_a3f9e34df8f070d77b1b063ef73f39199}{
\subsubsection[{"@31}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P$>$ anonymous enum}}
\label{d5/d5b/a00135_a3f9e34df8f070d77b1b063ef73f39199}


Dimension. 



Definition at line 87 of file core/site\_\-set/box.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00135_a5afc222197effb30a2be579e9c912b6b}{
\index{mln::box@{mln::box}!box@{box}}
\index{box@{box}!mln::box@{mln::box}}
\subsubsection[{box}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ {\bf mln::box}$<$ P $>$::{\bf box} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a5afc222197effb30a2be579e9c912b6b}


Constructor without argument. 



Definition at line 275 of file core/site\_\-set/box.hh.

\hypertarget{a00135_a54d1bae3d4afb2b108fd7eee6ab5afdb}{
\index{mln::box@{mln::box}!box@{box}}
\index{box@{box}!mln::box@{mln::box}}
\subsubsection[{box}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ {\bf mln::box}$<$ P $>$::{\bf box} (
\begin{DoxyParamCaption}
\item[{const {\bf site} \&}]{ pmin, }
\item[{const {\bf site} \&}]{ pmax}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a54d1bae3d4afb2b108fd7eee6ab5afdb}


Constructor of a box going from {\ttfamily pmin} to {\ttfamily pmax}. 



Definition at line 284 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().

\hypertarget{a00135_a9fae3d01446ea7040d4b25a3254bbda6}{
\index{mln::box@{mln::box}!box@{box}}
\index{box@{box}!mln::box@{mln::box}}
\subsubsection[{box}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ {\bf mln::box}$<$ P $>$::{\bf box} (
\begin{DoxyParamCaption}
\item[{typename P::coord}]{ ninds}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, explicit\mbox{]}}}}
\label{d5/d5b/a00135_a9fae3d01446ea7040d4b25a3254bbda6}
Constructors with different numbers of arguments (sizes) w.r.t. the dimension. 

Definition at line 293 of file core/site\_\-set/box.hh.



References mln::literal::origin.



\subsection{Member Function Documentation}
\hypertarget{a00028_a689abe6596bfbe40fa307fc0db3a9290}{
\index{mln::box@{mln::box}!bbox@{bbox}}
\index{bbox@{bbox}!mln::box@{mln::box}}
\subsubsection[{bbox}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf box}$<$ P $>$ \& {\bf mln::Box}$<$ {\bf box}$<$ P $>$  $>$::bbox (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{dc/d3c/a00028_a689abe6596bfbe40fa307fc0db3a9290}


Give the bounding box of this site set. 

Return the bounding box of this site 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{a00135_a356d219a67cd8998ab8ab691987b1f7a}{
\index{mln::box@{mln::box}!crop\_\-wrt@{crop\_\-wrt}}
\index{crop\_\-wrt@{crop\_\-wrt}!mln::box@{mln::box}}
\subsubsection[{crop\_\-wrt}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ void {\bf mln::box}$<$ P $>$::crop\_\-wrt (
\begin{DoxyParamCaption}
\item[{const {\bf box}$<$ P $>$ \&}]{ b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a356d219a67cd8998ab8ab691987b1f7a}


Crop this bbox in order to fit in the reference box {\ttfamily b}. 



Definition at line 205 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::pmax(), and mln::box$<$ P $>$::pmin().



Referenced by mln::debug::draw\_\-graph(), and mln::make\_\-debug\_\-graph\_\-image().

\hypertarget{a00135_a17f1a7ede7c9d422167e2f5271b343dd}{
\index{mln::box@{mln::box}!enlarge@{enlarge}}
\index{enlarge@{enlarge}!mln::box@{mln::box}}
\subsubsection[{enlarge}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ void {\bf mln::box}$<$ P $>$::enlarge (
\begin{DoxyParamCaption}
\item[{unsigned}]{ b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a17f1a7ede7c9d422167e2f5271b343dd}


Enlarge the box with a border {\ttfamily b}. 



Definition at line 337 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().



Referenced by mln::registration::icp().

\hypertarget{a00135_ac5995c9050f891a8f0fd4ff1b19f93d2}{
\index{mln::box@{mln::box}!enlarge@{enlarge}}
\index{enlarge@{enlarge}!mln::box@{mln::box}}
\subsubsection[{enlarge}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ void {\bf mln::box}$<$ P $>$::enlarge (
\begin{DoxyParamCaption}
\item[{unsigned}]{ dim, }
\item[{unsigned}]{ b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_ac5995c9050f891a8f0fd4ff1b19f93d2}


Enlarge the box with a border {\ttfamily b} for dimension {\ttfamily dim}. 



Definition at line 351 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().

\hypertarget{a00135_a5ed42357653e0e6d3deb6562dab2be34}{
\index{mln::box@{mln::box}!has@{has}}
\index{has@{has}!mln::box@{mln::box}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ bool {\bf mln::box}$<$ P $>$::has (
\begin{DoxyParamCaption}
\item[{const P \&}]{ p}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a5ed42357653e0e6d3deb6562dab2be34}


Test if {\ttfamily p} belongs to the box. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em p}]A point site. \end{DoxyParams}


Definition at line 325 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().



Referenced by mln::morpho::line\_\-gradient().

\hypertarget{a00028_a69fd0ab844d3721589ebf9fc7fa8384f}{
\index{mln::box@{mln::box}!is\_\-empty@{is\_\-empty}}
\index{is\_\-empty@{is\_\-empty}!mln::box@{mln::box}}
\subsubsection[{is\_\-empty}]{\setlength{\rightskip}{0pt plus 5cm}bool {\bf mln::Box}$<$ {\bf box}$<$ P $>$  $>$::is\_\-empty (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{dc/d3c/a00028_a69fd0ab844d3721589ebf9fc7fa8384f}


Test if this box is empty. 

\hypertarget{a00135_affe43575c510bd3cecc2659a7d163f47}{
\index{mln::box@{mln::box}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::box@{mln::box}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ bool {\bf mln::box}$<$ P $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_affe43575c510bd3cecc2659a7d163f47}


Test that the box owns valid data, i.e., is initialized and with pmin being 'less-\/than' pmax. 



Definition at line 195 of file core/site\_\-set/box.hh.



References mln::util::ord\_\-weak().



Referenced by mln::box$<$ P $>$::box(), mln::transform::distance\_\-and\_\-closest\_\-point\_\-geodesic(), mln::box$<$ P $>$::enlarge(), mln::box$<$ P $>$::has(), mln::box$<$ P $>$::merge(), mln::box$<$ P $>$::pcenter(), mln::box$<$ P $>$::pmax(), mln::box$<$ P $>$::pmin(), and mln::box$<$ P $>$::to\_\-larger().

\hypertarget{a00028_a312da6ad989593a69eccdaf01660f4d7}{
\index{mln::box@{mln::box}!len@{len}}
\index{len@{len}!mln::box@{mln::box}}
\subsubsection[{len}]{\setlength{\rightskip}{0pt plus 5cm}unsigned {\bf mln::Box}$<$ {\bf box}$<$ P $>$  $>$::len (
\begin{DoxyParamCaption}
\item[{unsigned}]{ i}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{dc/d3c/a00028_a312da6ad989593a69eccdaf01660f4d7}


Give the length of the {\ttfamily i-\/th} side of the box. 

\begin{DoxyPrecond}{Precondition}
i $<$ site::dim
\end{DoxyPrecond}
\begin{DoxyWarning}{Warning}
This method is final for all box classes. 
\end{DoxyWarning}
\hypertarget{a00135_a835180464da876558d358f888faf7396}{
\index{mln::box@{mln::box}!memory\_\-size@{memory\_\-size}}
\index{memory\_\-size@{memory\_\-size}!mln::box@{mln::box}}
\subsubsection[{memory\_\-size}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ std::size\_\-t {\bf mln::box}$<$ P $>$::memory\_\-size (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a835180464da876558d358f888faf7396}


Return the size of this site set in memory. 



Definition at line 407 of file core/site\_\-set/box.hh.

\hypertarget{a00135_a3f6d52c2f92fb4468b72357413c0e40c}{
\index{mln::box@{mln::box}!merge@{merge}}
\index{merge@{merge}!mln::box@{mln::box}}
\subsubsection[{merge}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ void {\bf mln::box}$<$ P $>$::merge (
\begin{DoxyParamCaption}
\item[{const {\bf box}$<$ P $>$ \&}]{ b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a3f6d52c2f92fb4468b72357413c0e40c}


Merge inplace with another box. 



Definition at line 221 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid(), mln::box$<$ P $>$::pmax(), and mln::box$<$ P $>$::pmin().

\hypertarget{a00028_a3c92d5b998f6b6faad7362fe84ff37dc}{
\index{mln::box@{mln::box}!nsites@{nsites}}
\index{nsites@{nsites}!mln::box@{mln::box}}
\subsubsection[{nsites}]{\setlength{\rightskip}{0pt plus 5cm}unsigned {\bf mln::Box}$<$ {\bf box}$<$ P $>$  $>$::nsites (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{dc/d3c/a00028_a3c92d5b998f6b6faad7362fe84ff37dc}


Give the number of sites of this box. 

Return the number of sites 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{a00135_a08619d07ef44192b67e299e58502d60d}{
\index{mln::box@{mln::box}!pcenter@{pcenter}}
\index{pcenter@{pcenter}!mln::box@{mln::box}}
\subsubsection[{pcenter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ P {\bf mln::box}$<$ P $>$::pcenter (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a08619d07ef44192b67e299e58502d60d}


Return the approximated central site of this box. 



Definition at line 395 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().

\hypertarget{a00135_a53cddd52fd53cfc140c983bd2e2d7be6}{
\index{mln::box@{mln::box}!pmax@{pmax}}
\index{pmax@{pmax}!mln::box@{mln::box}}
\subsubsection[{pmax}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ P {\bf mln::box}$<$ P $>$::pmax (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a53cddd52fd53cfc140c983bd2e2d7be6}


Maximum point. 



Definition at line 259 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().



Referenced by mln::box$<$ P $>$::crop\_\-wrt(), mln::make::image3d(), mln::larger\_\-than(), mln::io::fld::load(), and mln::box$<$ P $>$::merge().

\hypertarget{a00135_a24a3c38f2dcfbdb37602acd91ad3a049}{
\index{mln::box@{mln::box}!pmax@{pmax}}
\index{pmax@{pmax}!mln::box@{mln::box}}
\subsubsection[{pmax}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ P \& {\bf mln::box}$<$ P $>$::pmax (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a24a3c38f2dcfbdb37602acd91ad3a049}


Reference to the maximum point. 



Definition at line 268 of file core/site\_\-set/box.hh.

\hypertarget{a00135_ab08184645ea10b9927cc10b866f15d6b}{
\index{mln::box@{mln::box}!pmin@{pmin}}
\index{pmin@{pmin}!mln::box@{mln::box}}
\subsubsection[{pmin}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ P \& {\bf mln::box}$<$ P $>$::pmin (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_ab08184645ea10b9927cc10b866f15d6b}


Reference to the minimum point. 



Definition at line 251 of file core/site\_\-set/box.hh.

\hypertarget{a00135_abffcf1d1212d36fb2ed77bcbf1aeeb43}{
\index{mln::box@{mln::box}!pmin@{pmin}}
\index{pmin@{pmin}!mln::box@{mln::box}}
\subsubsection[{pmin}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ P {\bf mln::box}$<$ P $>$::pmin (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_abffcf1d1212d36fb2ed77bcbf1aeeb43}


Minimum point. 



Definition at line 242 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().



Referenced by mln::box$<$ P $>$::crop\_\-wrt(), mln::make::image3d(), mln::larger\_\-than(), mln::io::fld::load(), and mln::box$<$ P $>$::merge().

\hypertarget{a00135_a2951a6b2fded350d75e5d7e2bf524116}{
\index{mln::box@{mln::box}!to\_\-larger@{to\_\-larger}}
\index{to\_\-larger@{to\_\-larger}!mln::box@{mln::box}}
\subsubsection[{to\_\-larger}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ {\bf box}$<$ P $>$ {\bf mln::box}$<$ P $>$::to\_\-larger (
\begin{DoxyParamCaption}
\item[{unsigned}]{ b}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d5/d5b/a00135_a2951a6b2fded350d75e5d7e2bf524116}


Give a larger box. 



Definition at line 378 of file core/site\_\-set/box.hh.



References mln::box$<$ P $>$::is\_\-valid().



\subsection{Friends And Related Function Documentation}
\hypertarget{a00135_a4d3ea6ac1853456bf074636782343fcb}{
\index{mln::box@{mln::box}!operator$<$$<$@{operator$<$$<$}}
\index{operator$<$$<$@{operator$<$$<$}!mln::box@{mln::box}}
\subsubsection[{operator$<$$<$}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename P $>$ std::ostream \& operator$<$$<$ (
\begin{DoxyParamCaption}
\item[{std::ostream \&}]{ ostr, }
\item[{const {\bf box}$<$ P $>$ \&}]{ b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}related\mbox{]}}}}
\label{d5/d5b/a00135_a4d3ea6ac1853456bf074636782343fcb}


Print a generic box {\ttfamily b} into the output stream {\ttfamily ostr}. 


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


Definition at line 414 of file core/site\_\-set/box.hh.

