325 lines
26 KiB
TeX
325 lines
26 KiB
TeX
\hypertarget{classeo_standard_velocity}{}\doxysection{eo\+Standard\+Velocity$<$ P\+OT $>$ Class Template Reference}
|
|
\label{classeo_standard_velocity}\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
|
|
|
|
{\ttfamily \#include $<$eo\+Standard\+Velocity.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for eo\+Standard\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=334pt]{classeo_standard_velocity__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for eo\+Standard\+Velocity$<$ P\+OT $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classeo_standard_velocity__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Types}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_abb79f81840a96e817d39282fc3e4e078}\label{classeo_standard_velocity_abb79f81840a96e817d39282fc3e4e078}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_abb79f81840a96e817d39282fc3e4e078}\label{classeo_standard_velocity_abb79f81840a96e817d39282fc3e4e078}}
|
|
typedef P\+O\+T\+::\+Particle\+Velocity\+Type {\bfseries Velocity\+Type}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classeo_standard_velocity_a47463150fad04443b614ab1cfa535eae}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \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_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_standard_velocity_afea139549bb6c4350272a696f6c72f82}{get\+Topology}} ()
|
|
\item
|
|
\mbox{\hyperlink{classeo_standard_velocity_a47463150fad04443b614ab1cfa535eae}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \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_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} \&\+\_\+bounds, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
\mbox{\hyperlink{classeo_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}{eo\+Standard\+Velocity}} (\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, const Velocity\+Type \&\+\_\+w, const Velocity\+Type \&\+\_\+c1, const Velocity\+Type \&\+\_\+c2, \mbox{\hyperlink{classeo_rng}{eo\+Rng}} \&\+\_\+gen=rng)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}{operator()}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
void \mbox{\hyperlink{classeo_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}{update\+Neighborhood}} (P\+OT \&\+\_\+po, unsigned \+\_\+indice)
|
|
\item
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& \mbox{\hyperlink{classeo_standard_velocity_afea139549bb6c4350272a696f6c72f82}{get\+Topology}} ()
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a872e74a4c2fe5b6cdb01b1088e7f30a0}\label{classeo_standard_velocity_a872e74a4c2fe5b6cdb01b1088e7f30a0}}
|
|
\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \& {\bfseries topology}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_ad02c8dbec6e2543e8a610216ad30fc6a}\label{classeo_standard_velocity_ad02c8dbec6e2543e8a610216ad30fc6a}}
|
|
const Velocity\+Type \& {\bfseries omega}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a4b5193eeb157ba8b08f729673c6e7a80}\label{classeo_standard_velocity_a4b5193eeb157ba8b08f729673c6e7a80}}
|
|
const Velocity\+Type \& {\bfseries c1}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a0ddfde7d88fad51f81630c7aafc0812b}\label{classeo_standard_velocity_a0ddfde7d88fad51f81630c7aafc0812b}}
|
|
const Velocity\+Type \& {\bfseries c2}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a7c7250963c37711912dc4089536a486a}\label{classeo_standard_velocity_a7c7250963c37711912dc4089536a486a}}
|
|
\mbox{\hyperlink{classeo_real_vector_bounds}{eo\+Real\+Vector\+Bounds}} {\bfseries bounds}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a472916fb1a2c5a419306485e7617fb86}\label{classeo_standard_velocity_a472916fb1a2c5a419306485e7617fb86}}
|
|
\mbox{\hyperlink{classeo_real_bound_modifier}{eo\+Real\+Bound\+Modifier}} \& {\bfseries bnds\+Modifier}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_ac4939c36a81048aa77eca26d3840a2e4}\label{classeo_standard_velocity_ac4939c36a81048aa77eca26d3840a2e4}}
|
|
\mbox{\hyperlink{classeo_rng}{eo\+Rng}} \& {\bfseries gen}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_standard_velocity_ac133cb20385724c81711f2943d4e92e5}\label{classeo_standard_velocity_ac133cb20385724c81711f2943d4e92e5}}
|
|
\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\+Standard\+Velocity$<$ P\+O\+T $>$}
|
|
|
|
Standard 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) ) lbest depends on the topology evolved, when using \mbox{\hyperlink{classeo_star_topology}{eo\+Star\+Topology}}, lbest corresponds to the global. Otherwise, lbest is a \char`\"{}local best\char`\"{}, i.\+e the best in a neighborhood.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classeo_standard_velocity_a47463150fad04443b614ab1cfa535eae}\label{classeo_standard_velocity_a47463150fad04443b614ab1cfa535eae}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [1/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 \+\_\+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/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_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}\label{classeo_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [2/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 \+\_\+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/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_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}\label{classeo_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [3/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 get the global/local/other best \\
|
|
\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/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_standard_velocity_a47463150fad04443b614ab1cfa535eae}\label{classeo_standard_velocity_a47463150fad04443b614ab1cfa535eae}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [4/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 \+\_\+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/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_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}\label{classeo_standard_velocity_afc35d5886d4412cf5e05c3f87e06ff91}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [5/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 \+\_\+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/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_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}\label{classeo_standard_velocity_a93bca8a9d0b0fa5684c1a6874f1efe90}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!eoStandardVelocity@{eoStandardVelocity}}
|
|
\index{eoStandardVelocity@{eoStandardVelocity}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoStandardVelocity()}{eoStandardVelocity()}\hspace{0.1cm}{\footnotesize\ttfamily [6/6]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+Velocity}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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[{\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 get the global/local/other best \\
|
|
\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/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_standard_velocity_afea139549bb6c4350272a696f6c72f82}\label{classeo_standard_velocity_afea139549bb6c4350272a696f6c72f82}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ 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_standard_velocity}{eo\+Standard\+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_standard_velocity_afea139549bb6c4350272a696f6c72f82}\label{classeo_standard_velocity_afea139549bb6c4350272a696f6c72f82}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!getTopology@{getTopology}}
|
|
\index{getTopology@{getTopology}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ 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_standard_velocity}{eo\+Standard\+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_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}\label{classeo_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}\label{classeo_standard_velocity_a724c19eac5fb6c6836afad426aaeaa46}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{operator()()}{operator()()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}\label{classeo_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}\label{classeo_standard_velocity_a805dbeebfb2c11dae8b1da8dbf42605d}}
|
|
\index{eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}!updateNeighborhood@{updateNeighborhood}}
|
|
\index{updateNeighborhood@{updateNeighborhood}!eoStandardVelocity$<$ POT $>$@{eoStandardVelocity$<$ POT $>$}}
|
|
\doxysubsubsection{\texorpdfstring{updateNeighborhood()}{updateNeighborhood()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
|
|
void \mbox{\hyperlink{classeo_standard_velocity}{eo\+Standard\+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\+Standard\+Velocity.\+h\end{DoxyCompactItemize}
|