325 lines
26 KiB
TeX
325 lines
26 KiB
TeX
\hypertarget{classeo_integer_velocity}{}\doxysection{eo\+Integer\+Velocity$<$ P\+OT $>$ Class Template Reference}
|
|
\label{classeo_integer_velocity}\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
|
|
|
|
{\ttfamily \#include $<$eo\+Integer\+Velocity.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for eo\+Integer\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=334pt]{classeo_integer_velocity__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for eo\+Integer\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classeo_integer_velocity__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_aa345501121d2e92d77f160f2fea94357}\label{classeo_integer_velocity_aa345501121d2e92d77f160f2fea94357}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_aa345501121d2e92d77f160f2fea94357}\label{classeo_integer_velocity_aa345501121d2e92d77f160f2fea94357}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \&\+\_\+bnds\+Modifier, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}{get\+Topology}} ()
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \&\+\_\+bnds\+Modifier, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}{eo\+Integer\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, const Velocity\+Type \&\+\_\+c3, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}{get\+Topology}} ()
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_ae9fb6a0a7a26d7acebf4e5c55763512c}\label{classeo_integer_velocity_ae9fb6a0a7a26d7acebf4e5c55763512c}}
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& {\bfseries topology}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a8bf1cf8e84d48c58fc0f72b8d711865e}\label{classeo_integer_velocity_a8bf1cf8e84d48c58fc0f72b8d711865e}}
|
|
const Velocity\+Type \& {\bfseries c1}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a28ea59fd949f6b285dab0180b7ee5906}\label{classeo_integer_velocity_a28ea59fd949f6b285dab0180b7ee5906}}
|
|
const Velocity\+Type \& {\bfseries c2}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a2d1a70b288d9dd3025c83c574e9dad38}\label{classeo_integer_velocity_a2d1a70b288d9dd3025c83c574e9dad38}}
|
|
const Velocity\+Type \& {\bfseries c3}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a8a62f71b940c5bc2944ffd08fafb1ed5}\label{classeo_integer_velocity_a8a62f71b940c5bc2944ffd08fafb1ed5}}
|
|
\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} {\bfseries bounds}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a41890ccbc5136ded492a6f7bbcee19bf}\label{classeo_integer_velocity_a41890ccbc5136ded492a6f7bbcee19bf}}
|
|
\mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \& {\bfseries bnds\+Modifier}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_ae0a19b14e6d28dd6e7d4c27d86891217}\label{classeo_integer_velocity_ae0a19b14e6d28dd6e7d4c27d86891217}}
|
|
\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \& {\bfseries gen}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a452c00ee4b1d58668d90901e27ceb427}\label{classeo_integer_velocity_a452c00ee4b1d58668d90901e27ceb427}}
|
|
\mbox{\hyperlink{classeo_dummy_real_bound_modifier}{eo\+Dummy\+Real\+Bound\+Modifier}} {\bfseries dummy\+Modifier}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Additional Inherited Members}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\subsubsection*{template$<$class P\+OT$>$\newline
|
|
class eo\+Integer\+Velocity$<$ P\+O\+T $>$}
|
|
|
|
Integer velocity performer for particle swarm optimization. Derivated from abstract \mbox{\hyperlink{classeo_velocity}{eo\+Velocity}}, At step t\+: v(t+1)= c1 $\ast$ v(t) + c2 $\ast$ r2 $\ast$ ( xbest(t)-\/x(t) ) + c3 $\ast$ r3 $\ast$ ( gbest(t) -\/ x(t) ) v(t) is an I\+NT for any time step (ci given and Ri chosen at random in \mbox{[}0;1\mbox{]}).
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}\label{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [1/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&}]{\+\_\+bounds, }\item[{\mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \&}]{\+\_\+bnds\+Modifier, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Full constructor\+: Bounds and bound modifier required
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & -\/ The topology to get the global/local/other best \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+bounds} & -\/ An \mbox{\hyperlink{classeo_real_base_vector_bounds}{eo\+Real\+Base\+Vector\+Bounds}}\+: real bounds for real velocities. If the velocities are not real, they won\textquotesingle{}t be bounded by default. Should have a eo\+Bounds ? \\
|
|
\hline
|
|
{\em \+\_\+bnds\+Modifier} & -\/ An \mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} used to modify the bounds (for real bounds only). \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}\label{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [2/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&}]{\+\_\+bounds, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Constructor\+: No bound updater required $<$-\/$>$ fixed bounds
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & -\/ The topology to get the global/local/other best \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+bounds} & -\/ An \mbox{\hyperlink{classeo_real_base_vector_bounds}{eo\+Real\+Base\+Vector\+Bounds}}\+: real bounds for real velocities. If the velocities are not real, they won\textquotesingle{}t be bounded by default. Should have a eo\+Bounds ? \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}\label{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [3/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Constructor\+: Neither bounds nor bound updater required $<$-\/$>$ free velocity
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & the topology to use \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}\label{classeo_integer_velocity_a9933e4ec4bdc1290654cc5db32456389}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [4/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&}]{\+\_\+bounds, }\item[{\mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \&}]{\+\_\+bnds\+Modifier, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Full constructor\+: Bounds and bound modifier required
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & -\/ The topology to get the global/local/other best \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+bounds} & -\/ An \mbox{\hyperlink{classeo_real_base_vector_bounds}{eo\+Real\+Base\+Vector\+Bounds}}\+: real bounds for real velocities. If the velocities are not real, they won\textquotesingle{}t be bounded by default. Should have a eo\+Bounds ? \\
|
|
\hline
|
|
{\em \+\_\+bnds\+Modifier} & -\/ An \mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} used to modify the bounds (for real bounds only). \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}\label{classeo_integer_velocity_a22d393ed6c1fdcc13890994222095a53}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [5/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&}]{\+\_\+bounds, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Constructor\+: No bound updater required $<$-\/$>$ fixed bounds
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & -\/ The topology to get the global/local/other best \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+bounds} & -\/ An \mbox{\hyperlink{classeo_real_base_vector_bounds}{eo\+Real\+Base\+Vector\+Bounds}}\+: real bounds for real velocities. If the velocities are not real, they won\textquotesingle{}t be bounded by default. Should have a eo\+Bounds ? \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}\label{classeo_integer_velocity_a1a4b6b490fb7679d4bbdb05e45e85291}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!eoIntegerVelocity@{eoIntegerVelocity}}
|
|
\index{eoIntegerVelocity@{eoIntegerVelocity}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoIntegerVelocity()}{eoIntegerVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [6/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+c1, }\item[{const Velocity\+Type \&}]{\+\_\+c2, }\item[{const Velocity\+Type \&}]{\+\_\+c3, }\item[{\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&}]{\+\_\+gen = {\ttfamily rng} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Constructor\+: Neither bounds nor bound updater required $<$-\/$>$ free velocity
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+topology} & the topology to use \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The first learning factor quantify how much the particle trusts itself. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ The third learning factor used for the local/global best(s). Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}\label{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getTopology()}{getTopology()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$P\+OT$>$\& \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::get\+Topology (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
eo\+Topology$<$\+P\+O\+T$>$ get\+Topology \begin{DoxyReturn}{Returns}
|
|
topology
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_velocity}{eo\+Velocity$<$ P\+O\+T $>$}}.
|
|
|
|
\mbox{\Hypertarget{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}\label{classeo_integer_velocity_adbe65b0f170bbb9ee2891ca126495443}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getTopology()}{getTopology()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$P\+OT$>$\& \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::get\+Topology (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
eo\+Topology$<$\+P\+O\+T$>$ get\+Topology \begin{DoxyReturn}{Returns}
|
|
topology
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_velocity}{eo\+Velocity$<$ P\+O\+T $>$}}.
|
|
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}\label{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::operator() (\begin{DoxyParamCaption}\item[{P\+OT \&}]{\+\_\+po, }\item[{unsigned}]{\+\_\+indice }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Evaluate the new velocities of the given particle. Need an indice to identify the particle into the topology.
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+po} & -\/ A particle \\
|
|
\hline
|
|
{\em \+\_\+indice} & -\/ The indice (into the topology) of the given particle \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_b_f_aa03c40b95210569b826df79a2237a0d0}{eo\+B\+F$<$ P\+O\+T \&, unsigned, void $>$}}.
|
|
|
|
\mbox{\Hypertarget{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}\label{classeo_integer_velocity_a66968ad4135e21429f5a47c6c13d8842}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::operator() (\begin{DoxyParamCaption}\item[{P\+OT \&}]{\+\_\+po, }\item[{unsigned}]{\+\_\+indice }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Evaluate the new velocities of the given particle. Need an indice to identify the particle into the topology.
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+po} & -\/ A particle \\
|
|
\hline
|
|
{\em \+\_\+indice} & -\/ The indice (into the topology) of the given particle \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_b_f_aa03c40b95210569b826df79a2237a0d0}{eo\+B\+F$<$ P\+O\+T \&, unsigned, void $>$}}.
|
|
|
|
\mbox{\Hypertarget{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}\label{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::update\+Neighborhood (\begin{DoxyParamCaption}\item[{P\+OT \&}]{\+\_\+po, }\item[{unsigned}]{\+\_\+indice }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Update the neighborhood.
|
|
|
|
Reimplemented from \mbox{\hyperlink{classeo_velocity_a5e2310d90e8bc72782f4c865706b4549}{eo\+Velocity$<$ P\+O\+T $>$}}.
|
|
|
|
\mbox{\Hypertarget{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}\label{classeo_integer_velocity_aaef2aadb9c8f9c0258bf2ecaa496ba3a}}
|
|
\index{eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoIntegerVelocity$<$ POT $>$@{eoIntegerVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_integer_velocity}{eo\+Integer\+Velocity}}$<$ P\+OT $>$\+::update\+Neighborhood (\begin{DoxyParamCaption}\item[{P\+OT \&}]{\+\_\+po, }\item[{unsigned}]{\+\_\+indice }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Update the neighborhood.
|
|
|
|
Reimplemented from \mbox{\hyperlink{classeo_velocity_a5e2310d90e8bc72782f4c865706b4549}{eo\+Velocity$<$ P\+O\+T $>$}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
deprecated/eo/src/eo\+Integer\+Velocity.\+h\end{DoxyCompactItemize}
|