particle Class Reference

Class particle - stores the position, velocity and personal best With functions which move particle and update velocity. More...

#include <Fitters/Algorithms/PSO.h>

Collaboration diagram for particle:

Public Member Functions
	particle (const std::vector< double > &pos, const std::vector< double > &vel)
	Constructor. More...
virtual	~particle ()
	Destructor. More...
void	set_position (const std::vector< double > &new_position)
std::vector< double >	get_position ()
void	set_personal_best_position (const std::vector< double > &new_pos)
std::vector< double >	get_personal_best_position ()
void	set_personal_best_value (const double new_val)
double	get_personal_best_value ()
std::vector< double >	get_velocity ()
void	set_velocity (const std::vector< double > &new_velocity)
double	get_value ()
void	set_value (const double val)

Private Attributes
std::vector< double >	position
std::vector< double >	velocity
double	personal_best_value
double	curr_value
std::vector< double >	personal_best_position

Detailed Description

Class particle - stores the position, velocity and personal best With functions which move particle and update velocity.

Author

Emily Ip

Mark Scott

Date

24/2/2023

Definition at line 16 of file PSO.h.

Constructor & Destructor Documentation

particle()

particle::particle ( const std::vector< double > &  pos, const std::vector< double > &  vel  )

inline

Constructor.

Definition at line 19 of file PSO.h.

: position(pos), velocity(vel){};

~particle()

virtual particle::~particle ( )

inlinevirtual

Destructor.

Definition at line 21 of file PSO.h.

{};

Member Function Documentation

get_personal_best_position()

std::vector<double> particle::get_personal_best_position ( )

inline

Definition at line 35 of file PSO.h.

                                                    {
        return personal_best_position;
      };

get_personal_best_value()

double particle::get_personal_best_value ( )

inline

Definition at line 43 of file PSO.h.

                                      {
        return personal_best_value;
      };

get_position()

std::vector<double> particle::get_position ( )

inline

Definition at line 27 of file PSO.h.

                                       {
        return position;
      };

get_value()

double particle::get_value ( )

inline

Definition at line 55 of file PSO.h.

                        {
        return curr_value;
      };

get_velocity()

std::vector<double> particle::get_velocity ( )

inline

Definition at line 47 of file PSO.h.

                                      {
        return velocity;
      };

set_personal_best_position()

void particle::set_personal_best_position ( const std::vector< double > &  new_pos )

inline

Definition at line 31 of file PSO.h.

                                                                       {
        personal_best_position = new_pos;
      };

set_personal_best_value()

void particle::set_personal_best_value ( const double  new_val )

inline

Definition at line 39 of file PSO.h.

                                                        {
        personal_best_value = new_val;
      };

set_position()

void particle::set_position ( const std::vector< double > &  new_position )

inline

Definition at line 23 of file PSO.h.

                                                               {
        position = new_position;
      };

set_value()

void particle::set_value ( const double  val )

inline

Definition at line 58 of file PSO.h.

                                      {
        curr_value = val;
      };

set_velocity()

void particle::set_velocity ( const std::vector< double > &  new_velocity )

inline

Definition at line 51 of file PSO.h.

                                                              {
        velocity = new_velocity;
      };

Member Data Documentation

curr_value

double particle::curr_value

private

Definition at line 66 of file PSO.h.

personal_best_position

std::vector<double> particle::personal_best_position

private

Definition at line 67 of file PSO.h.

personal_best_value

double particle::personal_best_value

private

Definition at line 65 of file PSO.h.

position

std::vector<double> particle::position

private

Definition at line 63 of file PSO.h.

velocity

std::vector<double> particle::velocity

private

Definition at line 64 of file PSO.h.

---

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

• Fitters/Algorithms/PSO.h