Optimist::Optimizer::ExponentialDecrease2< Scalar > Class Template Reference

Inertia weight functor, which decreases exponentially over time. More...

#include <ParticleSwarm.hh>

Public Member Functions
	ExponentialDecrease2 ()
	ExponentialDecrease2 (const Scalar min_weight, const Scalar max_weight)
Scalar	operator() (const Integer iteration, const Integer max_iterations) const

Private Attributes
Scalar	m_min_weight {0.4}
Scalar	m_max_weight {0.9}

Detailed Description

template<typename Scalar>
class Optimist::Optimizer::ExponentialDecrease2< Scalar >

Template Parameters

Scalar

Floating-point number type. The inertia weight is calculated by the following formula: \[ w = w_{\min} + (w_{\max} - w_{\min}) * \exp\left(-\left(\frac{t}{\frac{t_{\max}}{4}}\right)^2 \right) \text{.} \]

Constructor & Destructor Documentation

ExponentialDecrease2() [1/2]

template<typename Scalar>

Optimist::Optimizer::ExponentialDecrease2< Scalar >::ExponentialDecrease2 ( )

inline

Class constructor with minimum and maximum weights equal to 0.4 and 0.9, respectively.

ExponentialDecrease2() [2/2]

template<typename Scalar>

Optimist::Optimizer::ExponentialDecrease2< Scalar >::ExponentialDecrease2 ( const Scalar min_weight, const Scalar max_weight )

inline

Class constructor that accepts the minimum and maximum weight of the exponential decrease.

Parameters

[in]	min_weight	Lower bound of the inertia weight
[in]	max_weight	Upper bound of the inertia weight

Member Function Documentation

operator()()

template<typename Scalar>

Scalar Optimist::Optimizer::ExponentialDecrease2< Scalar >::operator() ( const Integer iteration, const Integer max_iterations ) const

inline

Get the inertia weight.

Parameters

[in]	iteration	Current iteration.
[in]	max_iterations	Maximum number of iterations.

Returns

The inertia weight.

Member Data Documentation

m_max_weight

template<typename Scalar>

Scalar Optimist::Optimizer::ExponentialDecrease2< Scalar >::m_max_weight {0.9}

private

Maximum inertia weight

m_min_weight

template<typename Scalar>

Scalar Optimist::Optimizer::ExponentialDecrease2< Scalar >::m_min_weight {0.4}

private

Minimum inertia weight

---

The documentation for this class was generated from the following file:

• core/include/Optimist/Optimizer/ParticleSwarm.hh