127 lines
7.5 KiB
TeX
127 lines
7.5 KiB
TeX
\hypertarget{classmo_index_neighborhood}{}\doxysection{mo\+Index\+Neighborhood$<$ Neighbor $>$ Class Template Reference}
|
|
\label{classmo_index_neighborhood}\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
|
|
|
|
{\ttfamily \#include $<$mo\+Index\+Neighborhood.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for mo\+Index\+Neighborhood$<$ Neighbor $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classmo_index_neighborhood__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for mo\+Index\+Neighborhood$<$ Neighbor $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=247pt]{classmo_index_neighborhood__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
typedef \mbox{\hyperlink{classeo_bit}{Neighbor\+::\+E\+OT}} \mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classmo_index_neighborhood_ae574499bd8e80d9adfd00c282f01584a}{mo\+Index\+Neighborhood}} (unsigned int \+\_\+neighborhood\+Size)
|
|
\item
|
|
unsigned int \mbox{\hyperlink{classmo_index_neighborhood_a4840a0b4a491982d429c90cc20e23bd2}{get\+Neighborhood\+Size}} () const
|
|
\item
|
|
void \mbox{\hyperlink{classmo_index_neighborhood_a6da02b62292c21403382cce1cfa8df35}{set\+Neighborhood\+Size}} (unsigned int \+\_\+neighborhood\+Size)
|
|
\item
|
|
virtual std\+::string \mbox{\hyperlink{classmo_index_neighborhood_a56936b46687cf0529bcd59aa7eebaeed}{class\+Name}} () const
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_a6f5ad372f95132594c7f908577b86a61}\label{classmo_index_neighborhood_a6f5ad372f95132594c7f908577b86a61}}
|
|
unsigned int {\bfseries neighborhood\+Size}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\subsubsection*{template$<$class Neighbor$>$\newline
|
|
class mo\+Index\+Neighborhood$<$ Neighbor $>$}
|
|
|
|
A Indexed Neighborhood
|
|
|
|
\doxysubsection{Member Typedef Documentation}
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}\label{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}}
|
|
\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}!EOT@{EOT}}
|
|
\index{EOT@{EOT}!moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
\doxysubsubsection{\texorpdfstring{EOT}{EOT}}
|
|
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
|
|
typedef \mbox{\hyperlink{classeo_bit}{Neighbor\+::\+E\+OT}} \mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}}}
|
|
|
|
Define type of a solution corresponding to Neighbor
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_ae574499bd8e80d9adfd00c282f01584a}\label{classmo_index_neighborhood_ae574499bd8e80d9adfd00c282f01584a}}
|
|
\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}!moIndexNeighborhood@{moIndexNeighborhood}}
|
|
\index{moIndexNeighborhood@{moIndexNeighborhood}!moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
\doxysubsubsection{\texorpdfstring{moIndexNeighborhood()}{moIndexNeighborhood()}}
|
|
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
|
|
\mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::\mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}} (\begin{DoxyParamCaption}\item[{unsigned int}]{\+\_\+neighborhood\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Constructor
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+neighborhood\+Size} & the size of the neighborhood \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_a56936b46687cf0529bcd59aa7eebaeed}\label{classmo_index_neighborhood_a56936b46687cf0529bcd59aa7eebaeed}}
|
|
\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}!className@{className}}
|
|
\index{className@{className}!moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
\doxysubsubsection{\texorpdfstring{className()}{className()}}
|
|
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
|
|
virtual std\+::string \mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Return the class Name \begin{DoxyReturn}{Returns}
|
|
the class name as a std\+::string
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classmo_neighborhood_a6ed673e57794bfe49d80a2adf6ed3e77}{mo\+Neighborhood$<$ Neighbor $>$}}.
|
|
|
|
|
|
|
|
Reimplemented in \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_aa2ef6029814156e7c6ddf6450475bc40}{mo\+Rnd\+Without\+Repl\+Neighborhood$<$ Neighbor $>$}}, \mbox{\hyperlink{classmo_order_neighborhood_a1140351010aa639792f49a2363db3acf}{mo\+Order\+Neighborhood$<$ Neighbor $>$}}, \mbox{\hyperlink{classmo_order_neighborhood_a1140351010aa639792f49a2363db3acf}{mo\+Order\+Neighborhood$<$ bit\+Neighbor $>$}}, and \mbox{\hyperlink{classmo_rnd_with_repl_neighborhood_a4893efd5f00cdb791fe2fd5291389da0}{mo\+Rnd\+With\+Repl\+Neighborhood$<$ Neighbor $>$}}.
|
|
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_a4840a0b4a491982d429c90cc20e23bd2}\label{classmo_index_neighborhood_a4840a0b4a491982d429c90cc20e23bd2}}
|
|
\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}!getNeighborhoodSize@{getNeighborhoodSize}}
|
|
\index{getNeighborhoodSize@{getNeighborhoodSize}!moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getNeighborhoodSize()}{getNeighborhoodSize()}}
|
|
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
|
|
unsigned int \mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::get\+Neighborhood\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
getter to get the value of neighborhood\+Size \begin{DoxyReturn}{Returns}
|
|
the neighborhood\+Size
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classmo_index_neighborhood_a6da02b62292c21403382cce1cfa8df35}\label{classmo_index_neighborhood_a6da02b62292c21403382cce1cfa8df35}}
|
|
\index{moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}!setNeighborhoodSize@{setNeighborhoodSize}}
|
|
\index{setNeighborhoodSize@{setNeighborhoodSize}!moIndexNeighborhood$<$ Neighbor $>$@{moIndexNeighborhood$<$ Neighbor $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setNeighborhoodSize()}{setNeighborhoodSize()}}
|
|
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
|
|
void \mbox{\hyperlink{classmo_index_neighborhood}{mo\+Index\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::set\+Neighborhood\+Size (\begin{DoxyParamCaption}\item[{unsigned int}]{\+\_\+neighborhood\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Setter to fixe the neighood\+Size
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+neighborhood\+Size} & the value to set \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
mo/src/neighborhood/mo\+Index\+Neighborhood.\+h\end{DoxyCompactItemize}
|