342 lines
26 KiB
TeX
342 lines
26 KiB
TeX
\hypertarget{classeo_extended_velocity}{}\doxysection{eo\+Extended\+Velocity$<$ P\+OT $>$ Class Template Reference}
|
|
\label{classeo_extended_velocity}\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
|
|
|
|
{\ttfamily \#include $<$eo\+Extended\+Velocity.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for eo\+Extended\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=334pt]{classeo_extended_velocity__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for eo\+Extended\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classeo_extended_velocity__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a9def4f3c7f404757b3cc6afc7f1fdf77}\label{classeo_extended_velocity_a9def4f3c7f404757b3cc6afc7f1fdf77}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a9def4f3c7f404757b3cc6afc7f1fdf77}\label{classeo_extended_velocity_a9def4f3c7f404757b3cc6afc7f1fdf77}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}{get\+Topology}} ()
|
|
\item
|
|
\mbox{\hyperlink{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}{eo\+Extended\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, 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_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}{get\+Topology}} ()
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_aa30b93270228cbd436b2c779ccda058d}\label{classeo_extended_velocity_aa30b93270228cbd436b2c779ccda058d}}
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& {\bfseries topology}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a288e9cac87132e34fa07c3ffb14be7bb}\label{classeo_extended_velocity_a288e9cac87132e34fa07c3ffb14be7bb}}
|
|
const Velocity\+Type \& {\bfseries omega}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a05670a7a7814f852a4393120fb48eb7f}\label{classeo_extended_velocity_a05670a7a7814f852a4393120fb48eb7f}}
|
|
const Velocity\+Type \& {\bfseries c1}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a5cc6e53467c5487511d265f2bd0840d5}\label{classeo_extended_velocity_a5cc6e53467c5487511d265f2bd0840d5}}
|
|
const Velocity\+Type \& {\bfseries c2}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_ad5ff5ab0d0369c8e6078f5e763de6907}\label{classeo_extended_velocity_ad5ff5ab0d0369c8e6078f5e763de6907}}
|
|
const Velocity\+Type \& {\bfseries c3}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_abafac7b640bb92f2d6e7c690ba848abb}\label{classeo_extended_velocity_abafac7b640bb92f2d6e7c690ba848abb}}
|
|
\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} {\bfseries bounds}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a3b0a7b1355c90ba9c4f9c3fc6775db2d}\label{classeo_extended_velocity_a3b0a7b1355c90ba9c4f9c3fc6775db2d}}
|
|
\mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \& {\bfseries bnds\+Modifier}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a7653938c9d489de12d43565bf0504320}\label{classeo_extended_velocity_a7653938c9d489de12d43565bf0504320}}
|
|
\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \& {\bfseries gen}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_extended_velocity_af1b0f252201a078cf95ad6f7fb7b09cc}\label{classeo_extended_velocity_af1b0f252201a078cf95ad6f7fb7b09cc}}
|
|
\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\+Extended\+Velocity$<$ P\+O\+T $>$}
|
|
|
|
Extended velocity performer for particle swarm optimization.
|
|
|
|
Derivated from abstract \mbox{\hyperlink{classeo_velocity}{eo\+Velocity}}, At step t\+: v(t+1)= w $\ast$ v(t) + c1 $\ast$ r1 $\ast$ ( xbest(t)-\/x(t) ) + c2 $\ast$ r2 $\ast$ ( lbest(t) -\/ x(t) ) + c3 $\ast$ r3 $\ast$ ( gbest(t) -\/ x(t) ) It includes both a \char`\"{}topology\char`\"{} best and a global best in the social knowledge. Each topology provides a method to retrieve the global best $<$=$>$ the best of all the neighborhood the topology contains.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}\label{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [1/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ Learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ Learning factor used for the local best \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\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_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}\label{classeo_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [2/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The third learning factor used for the local best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\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_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}\label{classeo_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [3/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The third learning factor used for the local best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}\label{classeo_extended_velocity_af1efce4ee493b346fd8ead84ad0c6dd6}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [4/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ Learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ Learning factor used for the local best \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\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_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}\label{classeo_extended_velocity_a7d10d0fc4edef6e2126e69b4128f9240}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [5/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The third learning factor used for the local best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\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_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}\label{classeo_extended_velocity_a0971ceae3fd65eab68e012d90ad9b5e5}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!eoExtendedVelocity@{eoExtendedVelocity}}
|
|
\index{eoExtendedVelocity@{eoExtendedVelocity}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoExtendedVelocity()}{eoExtendedVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [6/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+Velocity}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{const Velocity\+Type \&}]{\+\_\+w, }\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 \\
|
|
\hline
|
|
{\em \+\_\+w} & -\/ The weight factor. \\
|
|
\hline
|
|
{\em \+\_\+c1} & -\/ The second learning factor used for the particle\textquotesingle{}s best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c2} & -\/ The third learning factor used for the local best. Type must be P\+O\+T\+::\+Particle\+Velocity\+Type \\
|
|
\hline
|
|
{\em \+\_\+c3} & -\/ Learning factor used for the global best \\
|
|
\hline
|
|
{\em \+\_\+gen} & -\/ The eo random generator, default=rng \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classeo_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}\label{classeo_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ 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_extended_velocity}{eo\+Extended\+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_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}\label{classeo_extended_velocity_a8dd43b7c77461c8026c93209e3f61fbd}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ 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_extended_velocity}{eo\+Extended\+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_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}\label{classeo_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+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_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}\label{classeo_extended_velocity_af6ee841135be86ebfd41c9ba3025672b}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+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_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}\label{classeo_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+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_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}\label{classeo_extended_velocity_a34d8d305ef3234326b0ccd77e05d2ec5}}
|
|
\index{eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoExtendedVelocity$<$ POT $>$@{eoExtendedVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_extended_velocity}{eo\+Extended\+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\+Extended\+Velocity.\+h\end{DoxyCompactItemize}
|