\hypertarget{a00379}{
\section{mln::topo::n\_\-face$<$ N, D $>$ Class Template Reference}
\label{d8/d95/a00379}\index{mln::topo::n\_\-face@{mln::topo::n\_\-face}}
}


{\ttfamily N-\/face} handle in a complex.  




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



Inheritance diagram for mln::topo::n\_\-face$<$ N, D $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=272pt]{d8/dd1/a03973}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{a00379_a5aaf568533505b0bb3d841f51af55ca6}{invalidate} ()
\begin{DoxyCompactList}\small\item\em Invalidate this handle. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00379_a32e77d8757a77fcc178a126be470b1da}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Is this handle valid? \item\end{DoxyCompactList}\item 
\hyperlink{a00379_a1ceb1bb837c0d548f42c8beb8d0b9a32}{n\_\-face} ()
\begin{DoxyCompactList}\small\item\em Build a non-\/initialized face handle. \item\end{DoxyCompactList}\item 
\hyperlink{a00379_aa93efdca291cda2dd870719199e5f22c}{n\_\-face} (\hyperlink{a00372}{complex}$<$ D $>$ \&\hyperlink{a00372}{complex}, unsigned face\_\-id)
\begin{DoxyCompactList}\small\item\em Build a face handle from {\itshape complex\/} and {\itshape face\_\-id\/}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
\hyperlink{a00372}{complex}$<$ D $>$ \hyperlink{a00379_a401355637ae3bfbcd4e8c7a40138e9d1}{cplx} () const 
\begin{DoxyCompactList}\small\item\em Accessors. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00379_ad32edbfea51a8766936c6334a12398bc}{face\_\-id} () const 
\begin{DoxyCompactList}\small\item\em Return the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00379_ad0cdb5b32f9053af497b14a51db698f5}{set\_\-cplx} (const \hyperlink{a00372}{complex}$<$ D $>$ \&cplx)
\begin{DoxyCompactList}\small\item\em Set the complex the face belongs to. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00379_aa27bb8ff18c5bd7f8dee06f257e45e60}{n} () const 
\begin{DoxyCompactList}\small\item\em Return the dimension of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00379_a986256518eb446492cad61ec85b2f280}{set\_\-face\_\-id} (unsigned face\_\-id)
\begin{DoxyCompactList}\small\item\em Set the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00379_a25ce9a2e9f03f9edcf89a0d495f8c8a5}{inc\_\-face\_\-id} ()
\begin{DoxyCompactList}\small\item\em Increment the id of the face. \item\end{DoxyCompactList}\item 
void \hyperlink{a00379_a575729fac959b8c20de79821198d6359}{dec\_\-face\_\-id} ()
\begin{DoxyCompactList}\small\item\em Decrement the id of the face. \item\end{DoxyCompactList}\item 
face\_\-data$<$ N, D $>$ \& \hyperlink{a00379_a8d1b20c73cb44426a52d6608fbf03c13}{data} () const 
\begin{DoxyCompactList}\small\item\em Return the mln::topo::face\_\-data pointed by this handle. \item\end{DoxyCompactList}\item 
std::vector$<$ \hyperlink{a00368}{algebraic\_\-n\_\-face}$<$ N-\/1, D $>$ $>$ \hyperlink{a00379_a0c8bf392f2b9aa7425ab773045730b86}{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{a00368}{algebraic\_\-n\_\-face}$<$ N+1, D $>$ $>$ \hyperlink{a00379_a9125d15e29fa5bc18ec25d0f267089bd}{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 N, unsigned D$>$ class mln::topo::n\_\-face$<$ N, D $>$}

{\ttfamily N-\/face} handle in a complex. Contrary to an \hyperlink{a00373}{mln::topo::face}, the dimension of an \hyperlink{a00379}{mln::topo::n\_\-face} is fixed. 

Definition at line 61 of file n\_\-face.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00379_a1ceb1bb837c0d548f42c8beb8d0b9a32}{
\index{mln::topo::n\_\-face@{mln::topo::n\_\-face}!n\_\-face@{n\_\-face}}
\index{n\_\-face@{n\_\-face}!mln::topo::n_face@{mln::topo::n\_\-face}}
\subsubsection[{n\_\-face}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned N, unsigned D$>$ {\bf mln::topo::n\_\-face}$<$ N, D $>$::{\bf n\_\-face} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d8/d95/a00379_a1ceb1bb837c0d548f42c8beb8d0b9a32}


Build a non-\/initialized face handle. 



Definition at line 159 of file n\_\-face.hh.



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

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


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



Definition at line 169 of file n\_\-face.hh.



\subsection{Member Function Documentation}
\hypertarget{a00379_a401355637ae3bfbcd4e8c7a40138e9d1}{
\index{mln::topo::n\_\-face@{mln::topo::n\_\-face}!cplx@{cplx}}
\index{cplx@{cplx}!mln::topo::n_face@{mln::topo::n\_\-face}}
\subsubsection[{cplx}]{\setlength{\rightskip}{0pt plus 5cm}template$<$unsigned N, unsigned D$>$ {\bf complex}$<$ D $>$ {\bf mln::topo::n\_\-face}$<$ N, D $>$::cplx (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d8/d95/a00379_a401355637ae3bfbcd4e8c7a40138e9d1}


Accessors. 

Return the complex the face belongs to. 

Definition at line 195 of file n\_\-face.hh.



Referenced by mln::topo::n\_\-faces\_\-set$<$ N, D $>$::add(), mln::topo::operator!=(), and mln::topo::operator==().

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


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



Definition at line 251 of file n\_\-face.hh.



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

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


Decrement the id of the face. 



Definition at line 243 of file n\_\-face.hh.

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


Return the id of the face. 



Definition at line 211 of file n\_\-face.hh.



Referenced by mln::topo::operator==().

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


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



Definition at line 270 of file n\_\-face.hh.



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



Referenced by mln::topo::edge().

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


Increment the id of the face. 



Definition at line 235 of file n\_\-face.hh.

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


Invalidate this handle. 



Definition at line 187 of file n\_\-face.hh.



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

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


Is this handle valid? 



Definition at line 179 of file n\_\-face.hh.



Referenced by mln::topo::algebraic\_\-n\_\-face$<$ N, D $>$::algebraic\_\-n\_\-face(), mln::topo::n\_\-face$<$ N, D $>$::data(), mln::topo::n\_\-face$<$ N, D $>$::higher\_\-dim\_\-adj\_\-faces(), mln::topo::n\_\-face$<$ N, D $>$::lower\_\-dim\_\-adj\_\-faces(), and mln::topo::n\_\-face$<$ N, D $>$::n\_\-face().

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


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



Definition at line 260 of file n\_\-face.hh.



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

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


Return the dimension of the face. 



Definition at line 203 of file n\_\-face.hh.

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


Set the complex the face belongs to. 



Definition at line 219 of file n\_\-face.hh.

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


Set the id of the face. 



Definition at line 227 of file n\_\-face.hh.



Referenced by mln::topo::n\_\-face$<$ N, D $>$::invalidate().

