\hypertarget{a00245}{
\section{mln::graph\_\-window\_\-piter$<$ S, W, I $>$ Class Template Reference}
\label{d6/d22/a00245}\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}}
}


Forward iterator on line graph window.  




{\ttfamily \#include $<$graph\_\-window\_\-piter.hh$>$}



Inherits site\_\-relative\_\-iterator\_\-base$<$ W, graph\_\-window\_\-piter$<$ S, W, I $>$, W::center\_\-t $>$, and impl\_\-selector$<$ W::center\_\-t, W::psite, graph\_\-window\_\-piter$<$ S, W, I $>$ $>$.

\subsection*{Public Types}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
typedef S::fun\_\-t::result \hyperlink{a00245_afbd9c6f1fdd506fe9800a532d10f7864}{P}
\begin{DoxyCompactList}\small\item\em Associated types

Type of the window elements. \item\end{DoxyCompactList}\item 
typedef W::center\_\-t \hyperlink{a00245_a2febe3c87671f700e9b8f7848db31903}{center\_\-t}
\begin{DoxyCompactList}\small\item\em Type of the window center. \item\end{DoxyCompactList}\item 
typedef W::graph\_\-element \hyperlink{a00245_ab78aa5f2e45cc76f56132efcc693c20d}{graph\_\-element}
\begin{DoxyCompactList}\small\item\em Type of the graph element pointed by this iterator. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{a00245_afec501df9a0f60e3867e559e8dbc324b}{change\_\-target\_\-site\_\-set} (const S \&s)
\begin{DoxyCompactList}\small\item\em Change the target site set. \item\end{DoxyCompactList}\item 
void \hyperlink{a00345_af705fa7e2dcd1c711097abed43395c40}{next} ()
\begin{DoxyCompactList}\small\item\em Go to the next element. \item\end{DoxyCompactList}\item 
const S \& \hyperlink{a00245_a912e1836ad075ece889a5ad6731a45a1}{target\_\-site\_\-set} () const 
\begin{DoxyCompactList}\small\item\em Return the target site set. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
\hyperlink{a00245_a7dcabaa614227f7de025e33f887a02ef}{graph\_\-window\_\-piter} ()
\begin{DoxyCompactList}\small\item\em Construction. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Pref $>$ }\\\hyperlink{a00245_a326bb01962154c8bb2773eb2639b6744}{graph\_\-window\_\-piter} (const \hyperlink{a00454}{Window}$<$ W $>$ \&win, const Pref \&p\_\-ref)
\begin{DoxyCompactList}\small\item\em To be used in case the center and neighbor sites have the same type and belong to the same site set. \item\end{DoxyCompactList}\item 
{\footnotesize template$<$typename Pref $>$ }\\\hyperlink{a00245_a0c79f69f7ccb979839c7add44758274d}{graph\_\-window\_\-piter} (const \hyperlink{a00454}{Window}$<$ W $>$ \&win, const \hyperlink{a00348}{Site\_\-Set}$<$ S $>$ \&target\_\-site\_\-set, const Pref \&p\_\-ref)
\begin{DoxyCompactList}\small\item\em To be used in case center and neighbors sites do not have the same type and do not belong to the same site set. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf }\par
{\em \label{_amgrpd41d8cd98f00b204e9800998ecf8427e}
 }\begin{DoxyCompactItemize}
\item 
const \hyperlink{a00245_ab78aa5f2e45cc76f56132efcc693c20d}{graph\_\-element} \& \hyperlink{a00245_a80b31e7019e183e544f840a294212a3c}{element} () const 
\begin{DoxyCompactList}\small\item\em Return the graph element pointed by this iterator. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00245_aac01bcc30f351fc9c41d43622f7910fc}{id} () const 
\begin{DoxyCompactList}\small\item\em Return the graph element id. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}


\subsection{Detailed Description}
\subsubsection*{template$<$typename S, typename W, typename I$>$ class mln::graph\_\-window\_\-piter$<$ S, W, I $>$}

Forward iterator on line graph window. 
\begin{DoxyTemplParams}{Template Parameters}
\item[{\em S}]is the site set type. \item[{\em W}]is the window type. \item[{\em I}]is the underlying iterator type. \end{DoxyTemplParams}


Definition at line 99 of file graph\_\-window\_\-piter.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00245_a2febe3c87671f700e9b8f7848db31903}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!center\_\-t@{center\_\-t}}
\index{center\_\-t@{center\_\-t}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{center\_\-t}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ typedef W::center\_\-t {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf center\_\-t}}}
\label{d6/d22/a00245_a2febe3c87671f700e9b8f7848db31903}


Type of the window center. 



Definition at line 120 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_ab78aa5f2e45cc76f56132efcc693c20d}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!graph\_\-element@{graph\_\-element}}
\index{graph\_\-element@{graph\_\-element}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{graph\_\-element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ typedef W::graph\_\-element {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf graph\_\-element}}}
\label{d6/d22/a00245_ab78aa5f2e45cc76f56132efcc693c20d}


Type of the graph element pointed by this iterator. 



Definition at line 122 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_afbd9c6f1fdd506fe9800a532d10f7864}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!P@{P}}
\index{P@{P}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{P}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ typedef S::fun\_\-t ::result {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf P}}}
\label{d6/d22/a00245_afbd9c6f1fdd506fe9800a532d10f7864}


Associated types

Type of the window elements. 



Definition at line 118 of file graph\_\-window\_\-piter.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00245_a7dcabaa614227f7de025e33f887a02ef}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!graph\_\-window\_\-piter@{graph\_\-window\_\-piter}}
\index{graph\_\-window\_\-piter@{graph\_\-window\_\-piter}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{graph\_\-window\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf graph\_\-window\_\-piter} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_a7dcabaa614227f7de025e33f887a02ef}


Construction. 



Definition at line 226 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_a326bb01962154c8bb2773eb2639b6744}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!graph\_\-window\_\-piter@{graph\_\-window\_\-piter}}
\index{graph\_\-window\_\-piter@{graph\_\-window\_\-piter}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{graph\_\-window\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ template$<$typename Pref $>$ {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf graph\_\-window\_\-piter} (
\begin{DoxyParamCaption}
\item[{const {\bf Window}$<$ W $>$ \&}]{ win, }
\item[{const Pref \&}]{ p\_\-ref}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_a326bb01962154c8bb2773eb2639b6744}


To be used in case the center and neighbor sites have the same type and belong to the same site set. 


\begin{DoxyParams}{Parameters}
\item[{\em win}]The underlying window. \item[{\em p\_\-ref}]\hyperlink{a00454}{Window} center. \end{DoxyParams}


Definition at line 235 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_a0c79f69f7ccb979839c7add44758274d}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!graph\_\-window\_\-piter@{graph\_\-window\_\-piter}}
\index{graph\_\-window\_\-piter@{graph\_\-window\_\-piter}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{graph\_\-window\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ template$<$typename Pref $>$ {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf graph\_\-window\_\-piter} (
\begin{DoxyParamCaption}
\item[{const {\bf Window}$<$ W $>$ \&}]{ win, }
\item[{const {\bf Site\_\-Set}$<$ S $>$ \&}]{ target\_\-site\_\-set, }
\item[{const Pref \&}]{ p\_\-ref}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_a0c79f69f7ccb979839c7add44758274d}


To be used in case center and neighbors sites do not have the same type and do not belong to the same site set. 


\begin{DoxyParams}{Parameters}
\item[{\em win}]The underlying window. \item[{\em target\_\-site\_\-set}]\hyperlink{a00343}{Site} set in which neighbor sites are extracted. \item[{\em p\_\-ref}]\hyperlink{a00454}{Window} center. \end{DoxyParams}


Definition at line 249 of file graph\_\-window\_\-piter.hh.



\subsection{Member Function Documentation}
\hypertarget{a00245_afec501df9a0f60e3867e559e8dbc324b}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!change\_\-target\_\-site\_\-set@{change\_\-target\_\-site\_\-set}}
\index{change\_\-target\_\-site\_\-set@{change\_\-target\_\-site\_\-set}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{change\_\-target\_\-site\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ void {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::change\_\-target\_\-site\_\-set (
\begin{DoxyParamCaption}
\item[{const S \&}]{ s}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_afec501df9a0f60e3867e559e8dbc324b}


Change the target site set. 

\hyperlink{a00454}{Window} elements different from the center come from the target site set. 

Definition at line 357 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_a80b31e7019e183e544f840a294212a3c}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!element@{element}}
\index{element@{element}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{element}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ const {\bf graph\_\-window\_\-piter}$<$ S, W, I $>$::{\bf graph\_\-element} \& {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::element (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_a80b31e7019e183e544f840a294212a3c}


Return the graph element pointed by this iterator. 



Definition at line 341 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00245_aac01bcc30f351fc9c41d43622f7910fc}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!id@{id}}
\index{id@{id}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{id}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ unsigned {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::id (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_aac01bcc30f351fc9c41d43622f7910fc}


Return the graph element id. 

FIXME: we do not want to have this member since there is an automatic conversion to the graph element. C++ does not seem to use this conversion operator. 

Definition at line 349 of file graph\_\-window\_\-piter.hh.

\hypertarget{a00345_af705fa7e2dcd1c711097abed43395c40}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!next@{next}}
\index{next@{next}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf mln::Site\_\-Iterator}$<$ {\bf graph\_\-window\_\-piter}$<$ S, W, I $>$  $>$::next (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d9/d48/a00345_af705fa7e2dcd1c711097abed43395c40}


Go to the next element. 

\begin{DoxyWarning}{Warning}
This is a final method; iterator classes should not re-\/defined this method. The actual \char`\"{}next\char`\"{} operation has to be defined through the {\itshape next\_\-\/} method.
\end{DoxyWarning}
\begin{DoxyPrecond}{Precondition}
The iterator is valid. 
\end{DoxyPrecond}
\hypertarget{a00245_a912e1836ad075ece889a5ad6731a45a1}{
\index{mln::graph\_\-window\_\-piter@{mln::graph\_\-window\_\-piter}!target\_\-site\_\-set@{target\_\-site\_\-set}}
\index{target\_\-site\_\-set@{target\_\-site\_\-set}!mln::graph_window_piter@{mln::graph\_\-window\_\-piter}}
\subsubsection[{target\_\-site\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename S , typename W , typename I $>$ const S \& {\bf mln::graph\_\-window\_\-piter}$<$ S, W, I $>$::target\_\-site\_\-set (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d6/d22/a00245_a912e1836ad075ece889a5ad6731a45a1}


Return the target site set. 

\hyperlink{a00454}{Window} elements different from the center come from the target site set. 

Definition at line 366 of file graph\_\-window\_\-piter.hh.

