\hypertarget{a00170}{
\section{mln::doc::Point\_\-Site$<$ E $>$ Struct Template Reference}
\label{d5/dcb/a00170}\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}}
}


Documentation class for \hyperlink{a00331}{mln::Point\_\-Site}.  




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

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \{ \hyperlink{a00170_ab28dc75f3646fa29ba48e123539d8cfba3ddcb077c54069eb2e97fb523cb926b5}{dim}
 \}
\item 
typedef void \hyperlink{a00170_ac6b2c0ea9df0724daac8b7cba9b73efd}{coord}
\item 
typedef void \hyperlink{a00170_afaa1a3c793b7c03209606c5045ecf1e4}{dpoint}
\begin{DoxyCompactList}\small\item\em Dpsite associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00170_ac203e5105cdf9bd66db72b05bfc1298d}{mesh}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00051}{Mesh} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00170_a2ba3835083e22c1cee8be5dfc91ab37f}{point}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00343}{Site} associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00170_ac6b2c0ea9df0724daac8b7cba9b73efd}{coord} \hyperlink{a00170_ad6e8e22f71f28839f8a11978e0147ae4}{operator\mbox{[}$\,$\mbox{]}} (unsigned i) const 
\begin{DoxyCompactList}\small\item\em Read-\/only access to the {\ttfamily i-\/th} coordinate value. \item\end{DoxyCompactList}\item 
const \hyperlink{a00170_a2ba3835083e22c1cee8be5dfc91ab37f}{point} \& \hyperlink{a00170_aa5a3ac20e4ed2a636dd03a6caecc4b58}{to\_\-point} () const 
\begin{DoxyCompactList}\small\item\em Give a reference to the corresponding point. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


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

Documentation class for \hyperlink{a00331}{mln::Point\_\-Site}. \begin{DoxySeeAlso}{See also}
\hyperlink{a00331}{mln::Point\_\-Site} 
\end{DoxySeeAlso}


Definition at line 37 of file doc/point\_\-site.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00170_ac6b2c0ea9df0724daac8b7cba9b73efd}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!coord@{coord}}
\index{coord@{coord}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{coord}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Point\_\-Site}$<$ E $>$::{\bf coord}}}
\label{d5/dcb/a00170_ac6b2c0ea9df0724daac8b7cba9b73efd}
Coordinate associated type. 

Definition at line 62 of file doc/point\_\-site.hh.

\hypertarget{a00170_afaa1a3c793b7c03209606c5045ecf1e4}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!dpoint@{dpoint}}
\index{dpoint@{dpoint}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{dpoint}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Point\_\-Site}$<$ E $>$::{\bf dpoint}}}
\label{d5/dcb/a00170_afaa1a3c793b7c03209606c5045ecf1e4}


Dpsite associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00177}{mln::Dpoint}. 
\end{DoxyInvariant}


Definition at line 58 of file doc/point\_\-site.hh.

\hypertarget{a00170_ac203e5105cdf9bd66db72b05bfc1298d}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!mesh@{mesh}}
\index{mesh@{mesh}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{mesh}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Point\_\-Site}$<$ E $>$::{\bf mesh}}}
\label{d5/dcb/a00170_ac203e5105cdf9bd66db72b05bfc1298d}


\hyperlink{a00051}{Mesh} associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00051}{mln::Mesh}. 
\end{DoxyInvariant}


Definition at line 48 of file doc/point\_\-site.hh.

\hypertarget{a00170_a2ba3835083e22c1cee8be5dfc91ab37f}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!point@{point}}
\index{point@{point}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{point}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Point\_\-Site}$<$ E $>$::{\bf point}}}
\label{d5/dcb/a00170_a2ba3835083e22c1cee8be5dfc91ab37f}


\hyperlink{a00343}{Site} associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00329}{mln::Point}. 
\end{DoxyInvariant}


Definition at line 53 of file doc/point\_\-site.hh.



\subsection{Member Enumeration Documentation}
\hypertarget{a00170_ab28dc75f3646fa29ba48e123539d8cfb}{
\subsubsection[{"@20}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ anonymous enum}}
\label{d5/dcb/a00170_ab28dc75f3646fa29ba48e123539d8cfb}
\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{dim@{dim}!mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}}\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!dim@{dim}}\item[{\em 
\hypertarget{a00170_ab28dc75f3646fa29ba48e123539d8cfba3ddcb077c54069eb2e97fb523cb926b5}{
dim}
\label{d5/dcb/a00170_ab28dc75f3646fa29ba48e123539d8cfba3ddcb077c54069eb2e97fb523cb926b5}
}]Dimension of the space. \begin{DoxyInvariant}{Invariant}
dim $>$ 0 
\end{DoxyInvariant}
\end{description}
\end{Desc}



Definition at line 43 of file doc/point\_\-site.hh.



\subsection{Member Function Documentation}
\hypertarget{a00170_ad6e8e22f71f28839f8a11978e0147ae4}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!operator\mbox{[}\mbox{]}@{operator[]}}
\index{operator\mbox{[}\mbox{]}@{operator[]}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{operator[]}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ {\bf coord} {\bf mln::doc::Point\_\-Site}$<$ E $>$::operator\mbox{[}$\,$\mbox{]} (
\begin{DoxyParamCaption}
\item[{unsigned}]{ i}
\end{DoxyParamCaption}
) const}}
\label{d5/dcb/a00170_ad6e8e22f71f28839f8a11978e0147ae4}


Read-\/only access to the {\ttfamily i-\/th} coordinate value. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em i}]The coordinate index.\end{DoxyParams}
\begin{DoxyPrecond}{Precondition}
{\ttfamily i} $<$ {\ttfamily dim} 
\end{DoxyPrecond}
\begin{DoxyReturn}{Returns}
The value of the {\ttfamily i-\/th} coordinate. 
\end{DoxyReturn}
\hypertarget{a00170_aa5a3ac20e4ed2a636dd03a6caecc4b58}{
\index{mln::doc::Point\_\-Site@{mln::doc::Point\_\-Site}!to\_\-point@{to\_\-point}}
\index{to\_\-point@{to\_\-point}!mln::doc::Point_Site@{mln::doc::Point\_\-Site}}
\subsubsection[{to\_\-point}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf point}\& {\bf mln::doc::Point\_\-Site}$<$ E $>$::to\_\-point (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d5/dcb/a00170_aa5a3ac20e4ed2a636dd03a6caecc4b58}


Give a reference to the corresponding point. 

This method allows for iterators to refer to a point.

\begin{DoxyReturn}{Returns}
A point constant reference. 
\end{DoxyReturn}
