\hypertarget{a00373}{
\section{mln::topo::face$<$ D $>$ Class Template Reference}
\label{dc/de3/a00373}\index{mln::topo::face@{mln::topo::face}}
}


Face handle in a complex; the face dimension is dynamic.  




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



Inheritance diagram for mln::topo::face$<$ D $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=246pt]{db/dc8/a03964}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00373_a0bdc099b6e6191e2ef9b98ed29360064}{face} ()
\begin{DoxyCompactList}\small\item\em Build a non-\/initialized face handle. \item\end{DoxyCompactList}\item 
\hyperlink{a00373_ada211f8d8ab224e8941500267bdf1742}{face} (\hyperlink{a00372}{complex}$<$ D $>$ \&\hyperlink{a00372}{complex}, unsigned n, unsigned face\_\-id)
\begin{DoxyCompactList}\small\item\em Build a face handle from {\itshape complex\/} and {\itshape face\_\-id\/}. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$unsigned N$>$ }\\\hyperlink{a00373_a4c0bb64c8db7671ec0b12347009eee95}{face} (const \hyperlink{a00379}{n\_\-face}$<$ N, D $>$ \&f)
\begin{DoxyCompactList}\small\item\em Build a face handle from an \hyperlink{a00379}{mln::topo::n\_\-face}. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a34451080421c12cab8b9bc03831c34d1}{invalidate} ()
\begin{DoxyCompactList}\small\item\em Invalidate this handle. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00373_a3efdfa6fb4ab3047bb978b8bc19d2fbc}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Is this handle valid? \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
\hyperlink{a00372}{complex}$<$ D $>$ \hyperlink{a00373_a5be9913709b73833261294dbae601eff}{cplx} () const 
\begin{DoxyCompactList}\small\item\em Accessors. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00373_a680d494c86b88fe333c8d66f10448d30}{n} () const 
\begin{DoxyCompactList}\small\item\em Return the dimension of the face. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00373_a930edb7da8d7c634fd597e62374c0186}{face\_\-id} () const 
\begin{DoxyCompactList}\small\item\em Return the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_aab2c8f4550110bfe7b6255167dcee1cf}{set\_\-cplx} (const \hyperlink{a00372}{complex}$<$ D $>$ \&cplx)
\begin{DoxyCompactList}\small\item\em Set the complex the face belongs to. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_ae67f1584a69789f4fccdb0cfb70074c0}{set\_\-n} (unsigned n)
\begin{DoxyCompactList}\small\item\em Set the dimension of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a41d46ab725b15bc939597e988679dd5e}{inc\_\-n} ()
\begin{DoxyCompactList}\small\item\em Increment the dimension of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a192779025b7c8b5acd535cd85f7be418}{dec\_\-n} ()
\begin{DoxyCompactList}\small\item\em Decrement the dimension of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a7e0a1759b0f49474b24f44d5cf1e4479}{set\_\-face\_\-id} (unsigned face\_\-id)
\begin{DoxyCompactList}\small\item\em Set the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a0a4f5f6c32e58445a73130d9c3b6480e}{inc\_\-face\_\-id} ()
\begin{DoxyCompactList}\small\item\em Increment the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00373_a69e1d8aef244925d7a29de3fecd55dc5}{dec\_\-face\_\-id} ()
\begin{DoxyCompactList}\small\item\em Decrement the id of the face. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$unsigned N$>$ }\\face\_\-data$<$ N, D $>$ \& \hyperlink{a00373_aad8993113fdca8b68953fbee9cdbc505}{data} () const 
\begin{DoxyCompactList}\small\item\em Return the mln::topo::face\_\-data pointed by this handle. \item\end{DoxyCompactList}\item 
std::vector$<$ \hyperlink{a00367}{algebraic\_\-face}$<$ D $>$ $>$ \hyperlink{a00373_a790c6775c005a7d4047f863c4471257f}{lower\_\-dim\_\-adj\_\-faces} () const 
\begin{DoxyCompactList}\small\item\em Return an array of face handles pointing to adjacent (n-\/1)-\/faces. \item\end{DoxyCompactList}\item 
std::vector$<$ \hyperlink{a00367}{algebraic\_\-face}$<$ D $>$ $>$ \hyperlink{a00373_a6883135383485b7cd781d46de248ec47}{higher\_\-dim\_\-adj\_\-faces} () const 
\begin{DoxyCompactList}\small\item\em Return an array of face handles pointing to adjacent (n+1)-\/faces. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}


\subsection{Detailed Description}
\subsubsection*{template$<$unsigned D$>$ class mln::topo::face$<$ D $>$}

Face handle in a complex; the face dimension is dynamic. Contrary to an \hyperlink{a00379}{mln::topo::n\_\-face}, the dimension of an \hyperlink{a00373}{mln::topo::face} is not fixed. 

Definition at line 64 of file face.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00373_a0bdc099b6e6191e2ef9b98ed29360064}{
\index{mln::topo::face@{mln::topo::face}!face@{face}}
\index{face@{face}!mln::topo::face@{mln::topo::face}}
\subsubsection[{face}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ {\bf mln::topo::face}$<$ D $>$::{\bf face} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a0bdc099b6e6191e2ef9b98ed29360064}


Build a non-\/initialized face handle. 



Definition at line 178 of file face.hh.

\hypertarget{a00373_ada211f8d8ab224e8941500267bdf1742}{
\index{mln::topo::face@{mln::topo::face}!face@{face}}
\index{face@{face}!mln::topo::face@{mln::topo::face}}
\subsubsection[{face}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ {\bf mln::topo::face}$<$ D $>$::{\bf face} (
\begin{DoxyParamCaption}
\item[{{\bf complex}$<$ D $>$ \&}]{ complex, }
\item[{unsigned}]{ n, }
\item[{unsigned}]{ face\_\-id}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_ada211f8d8ab224e8941500267bdf1742}


Build a face handle from {\itshape complex\/} and {\itshape face\_\-id\/}. 



Definition at line 187 of file face.hh.

\hypertarget{a00373_a4c0bb64c8db7671ec0b12347009eee95}{
\index{mln::topo::face@{mln::topo::face}!face@{face}}
\index{face@{face}!mln::topo::face@{mln::topo::face}}
\subsubsection[{face}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ template$<$unsigned N$>$ {\bf mln::topo::face}$<$ D $>$::{\bf face} (
\begin{DoxyParamCaption}
\item[{const {\bf n\_\-face}$<$ N, D $>$ \&}]{ f}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a4c0bb64c8db7671ec0b12347009eee95}


Build a face handle from an \hyperlink{a00379}{mln::topo::n\_\-face}. 



Definition at line 197 of file face.hh.



\subsection{Member Function Documentation}
\hypertarget{a00373_a5be9913709b73833261294dbae601eff}{
\index{mln::topo::face@{mln::topo::face}!cplx@{cplx}}
\index{cplx@{cplx}!mln::topo::face@{mln::topo::face}}
\subsubsection[{cplx}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ {\bf complex}$<$ D $>$ {\bf mln::topo::face}$<$ D $>$::cplx (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a5be9913709b73833261294dbae601eff}


Accessors. 

Return the complex the face belongs to. 

Definition at line 224 of file face.hh.



Referenced by mln::complex\_\-psite$<$ D, G $>$::complex\_\-psite(), mln::topo::operator!=(), and mln::topo::operator==().

\hypertarget{a00373_aad8993113fdca8b68953fbee9cdbc505}{
\index{mln::topo::face@{mln::topo::face}!data@{data}}
\index{data@{data}!mln::topo::face@{mln::topo::face}}
\subsubsection[{data}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ template$<$unsigned N$>$ face\_\-data$<$ N, D $>$ \& {\bf mln::topo::face}$<$ D $>$::data (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_aad8993113fdca8b68953fbee9cdbc505}


Return the mln::topo::face\_\-data pointed by this handle. 



Definition at line 305 of file face.hh.



References mln::topo::face$<$ D $>$::is\_\-valid().

\hypertarget{a00373_a69e1d8aef244925d7a29de3fecd55dc5}{
\index{mln::topo::face@{mln::topo::face}!dec\_\-face\_\-id@{dec\_\-face\_\-id}}
\index{dec\_\-face\_\-id@{dec\_\-face\_\-id}!mln::topo::face@{mln::topo::face}}
\subsubsection[{dec\_\-face\_\-id}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::dec\_\-face\_\-id (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a69e1d8aef244925d7a29de3fecd55dc5}


Decrement the id of the face. 



Definition at line 296 of file face.hh.

\hypertarget{a00373_a192779025b7c8b5acd535cd85f7be418}{
\index{mln::topo::face@{mln::topo::face}!dec\_\-n@{dec\_\-n}}
\index{dec\_\-n@{dec\_\-n}!mln::topo::face@{mln::topo::face}}
\subsubsection[{dec\_\-n}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::dec\_\-n (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a192779025b7c8b5acd535cd85f7be418}


Decrement the dimension of the face. 



Definition at line 272 of file face.hh.

\hypertarget{a00373_a930edb7da8d7c634fd597e62374c0186}{
\index{mln::topo::face@{mln::topo::face}!face\_\-id@{face\_\-id}}
\index{face\_\-id@{face\_\-id}!mln::topo::face@{mln::topo::face}}
\subsubsection[{face\_\-id}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ unsigned {\bf mln::topo::face}$<$ D $>$::face\_\-id (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a930edb7da8d7c634fd597e62374c0186}


Return the id of the face. 



Definition at line 240 of file face.hh.



Referenced by mln::geom::complex\_\-geometry$<$ D, P $>$::operator()(), and mln::topo::operator==().

\hypertarget{a00373_a6883135383485b7cd781d46de248ec47}{
\index{mln::topo::face@{mln::topo::face}!higher\_\-dim\_\-adj\_\-faces@{higher\_\-dim\_\-adj\_\-faces}}
\index{higher\_\-dim\_\-adj\_\-faces@{higher\_\-dim\_\-adj\_\-faces}!mln::topo::face@{mln::topo::face}}
\subsubsection[{higher\_\-dim\_\-adj\_\-faces}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ std::vector$<$ {\bf algebraic\_\-face}$<$ D $>$ $>$ {\bf mln::topo::face}$<$ D $>$::higher\_\-dim\_\-adj\_\-faces (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a6883135383485b7cd781d46de248ec47}


Return an array of face handles pointing to adjacent (n+1)-\/faces. 



Definition at line 370 of file face.hh.

\hypertarget{a00373_a0a4f5f6c32e58445a73130d9c3b6480e}{
\index{mln::topo::face@{mln::topo::face}!inc\_\-face\_\-id@{inc\_\-face\_\-id}}
\index{inc\_\-face\_\-id@{inc\_\-face\_\-id}!mln::topo::face@{mln::topo::face}}
\subsubsection[{inc\_\-face\_\-id}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::inc\_\-face\_\-id (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a0a4f5f6c32e58445a73130d9c3b6480e}


Increment the id of the face. 



Definition at line 288 of file face.hh.

\hypertarget{a00373_a41d46ab725b15bc939597e988679dd5e}{
\index{mln::topo::face@{mln::topo::face}!inc\_\-n@{inc\_\-n}}
\index{inc\_\-n@{inc\_\-n}!mln::topo::face@{mln::topo::face}}
\subsubsection[{inc\_\-n}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::inc\_\-n (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a41d46ab725b15bc939597e988679dd5e}


Increment the dimension of the face. 



Definition at line 264 of file face.hh.

\hypertarget{a00373_a34451080421c12cab8b9bc03831c34d1}{
\index{mln::topo::face@{mln::topo::face}!invalidate@{invalidate}}
\index{invalidate@{invalidate}!mln::topo::face@{mln::topo::face}}
\subsubsection[{invalidate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::invalidate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a34451080421c12cab8b9bc03831c34d1}


Invalidate this handle. 



Definition at line 215 of file face.hh.



References mln::topo::face$<$ D $>$::set\_\-face\_\-id(), and mln::topo::face$<$ D $>$::set\_\-n().

\hypertarget{a00373_a3efdfa6fb4ab3047bb978b8bc19d2fbc}{
\index{mln::topo::face@{mln::topo::face}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::topo::face@{mln::topo::face}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ bool {\bf mln::topo::face}$<$ D $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a3efdfa6fb4ab3047bb978b8bc19d2fbc}


Is this handle valid? 



Definition at line 207 of file face.hh.



Referenced by mln::topo::face$<$ D $>$::data().

\hypertarget{a00373_a790c6775c005a7d4047f863c4471257f}{
\index{mln::topo::face@{mln::topo::face}!lower\_\-dim\_\-adj\_\-faces@{lower\_\-dim\_\-adj\_\-faces}}
\index{lower\_\-dim\_\-adj\_\-faces@{lower\_\-dim\_\-adj\_\-faces}!mln::topo::face@{mln::topo::face}}
\subsubsection[{lower\_\-dim\_\-adj\_\-faces}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ std::vector$<$ {\bf algebraic\_\-face}$<$ D $>$ $>$ {\bf mln::topo::face}$<$ D $>$::lower\_\-dim\_\-adj\_\-faces (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a790c6775c005a7d4047f863c4471257f}


Return an array of face handles pointing to adjacent (n-\/1)-\/faces. 



Definition at line 357 of file face.hh.

\hypertarget{a00373_a680d494c86b88fe333c8d66f10448d30}{
\index{mln::topo::face@{mln::topo::face}!n@{n}}
\index{n@{n}!mln::topo::face@{mln::topo::face}}
\subsubsection[{n}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ unsigned {\bf mln::topo::face}$<$ D $>$::n (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a680d494c86b88fe333c8d66f10448d30}


Return the dimension of the face. 



Definition at line 232 of file face.hh.



Referenced by mln::topo::algebraic\_\-face$<$ D $>$::algebraic\_\-face(), mln::geom::complex\_\-geometry$<$ D, P $>$::operator()(), and mln::topo::operator==().

\hypertarget{a00373_aab2c8f4550110bfe7b6255167dcee1cf}{
\index{mln::topo::face@{mln::topo::face}!set\_\-cplx@{set\_\-cplx}}
\index{set\_\-cplx@{set\_\-cplx}!mln::topo::face@{mln::topo::face}}
\subsubsection[{set\_\-cplx}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::set\_\-cplx (
\begin{DoxyParamCaption}
\item[{const {\bf complex}$<$ D $>$ \&}]{ cplx}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_aab2c8f4550110bfe7b6255167dcee1cf}


Set the complex the face belongs to. 



Definition at line 248 of file face.hh.

\hypertarget{a00373_a7e0a1759b0f49474b24f44d5cf1e4479}{
\index{mln::topo::face@{mln::topo::face}!set\_\-face\_\-id@{set\_\-face\_\-id}}
\index{set\_\-face\_\-id@{set\_\-face\_\-id}!mln::topo::face@{mln::topo::face}}
\subsubsection[{set\_\-face\_\-id}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::set\_\-face\_\-id (
\begin{DoxyParamCaption}
\item[{unsigned}]{ face\_\-id}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_a7e0a1759b0f49474b24f44d5cf1e4479}


Set the id of the face. 



Definition at line 280 of file face.hh.



Referenced by mln::topo::face$<$ D $>$::invalidate().

\hypertarget{a00373_ae67f1584a69789f4fccdb0cfb70074c0}{
\index{mln::topo::face@{mln::topo::face}!set\_\-n@{set\_\-n}}
\index{set\_\-n@{set\_\-n}!mln::topo::face@{mln::topo::face}}
\subsubsection[{set\_\-n}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned D$>$ void {\bf mln::topo::face}$<$ D $>$::set\_\-n (
\begin{DoxyParamCaption}
\item[{unsigned}]{ n}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{dc/de3/a00373_ae67f1584a69789f4fccdb0cfb70074c0}


Set the dimension of the face. 



Definition at line 256 of file face.hh.



Referenced by mln::topo::face$<$ D $>$::invalidate().

