core::optimization::Particle Class Reference

Simple data container for PSO algorithm. More...

#include <ParticleSwarmMinimizer.hh>

Inheritance diagram for core::optimization::Particle:

Public Member Functions
	Particle (Size size)
	Particle (Multivec const &p_in)
	~Particle () override=default
Real	score (Multifunc &f)
Real	set_score (Real &new_score)
void	ensure_size (Size minsize)
	Make sure that all arrays are large enough – prevents index-out-of-bound errors. More...
Multivec const &	pbest () const
	This is why data should be private: you get to ensure it's valid when you read it. More...
Real	fitness_pbest () const

Public Attributes
Multivec	p_
Real	fitness_
Multivec	v_

Private Attributes
bool	best_valid_
Multivec	pbest_
Real	fitness_pbest_

Detailed Description

Simple data container for PSO algorithm.

Constructor & Destructor Documentation

core::optimization::Particle::Particle ( Size  size )

inline

core::optimization::Particle::Particle ( Multivec const &  p_in )

inline

core::optimization::Particle::~Particle ( )

overridedefault

Member Function Documentation

void core::optimization::Particle::ensure_size ( Size  minsize )

inline

Make sure that all arrays are large enough – prevents index-out-of-bound errors.

References p_, pbest_, and v_.

Real core::optimization::Particle::fitness_pbest ( ) const

inline

References best_valid_, and fitness_pbest_.

Referenced by core::optimization::operator<<().

Multivec const& core::optimization::Particle::pbest ( ) const

inline

This is why data should be private: you get to ensure it's valid when you read it.

References best_valid_, and pbest_.

Real core::optimization::Particle::score ( Multifunc &  f )

inline

References best_valid_, fitness_, fitness_pbest_, p_, and pbest_.

Real core::optimization::Particle::set_score ( Real &  new_score )

inline

References best_valid_, fitness_, fitness_pbest_, p_, and pbest_.

Member Data Documentation

bool core::optimization::Particle::best_valid_

private

Referenced by fitness_pbest(), pbest(), score(), and set_score().

Real core::optimization::Particle::fitness_

Referenced by core::optimization::operator<<(), score(), and set_score().

Real core::optimization::Particle::fitness_pbest_

private

Referenced by fitness_pbest(), score(), and set_score().

Multivec core::optimization::Particle::p_

Referenced by ensure_size(), core::optimization::operator<<(), score(), and set_score().

Multivec core::optimization::Particle::pbest_

private

Referenced by ensure_size(), pbest(), score(), and set_score().

Multivec core::optimization::Particle::v_

Referenced by ensure_size().

---

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

• src/core/optimization/ParticleSwarmMinimizer.hh