MaCh3 2.2.1
Reference Guide
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
particle Class Reference

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

#include <Fitters/PSO.h>

Collaboration diagram for particle:
[legend]

Public Member Functions

 particle (const std::vector< double > &pos, const std::vector< double > &vel)
 Constructor.
 
virtual ~particle ()
 Destructor.
 
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 17 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 20 of file PSO.h.

20: position(pos), velocity(vel){};
std::vector< double > position
Definition: PSO.h:64
std::vector< double > velocity
Definition: PSO.h:65

◆ ~particle()

virtual particle::~particle ( )
inlinevirtual

Destructor.

Definition at line 22 of file PSO.h.

22{};

Member Function Documentation

◆ get_personal_best_position()

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

Definition at line 36 of file PSO.h.

36 {
38 };
std::vector< double > personal_best_position
Definition: PSO.h:68

◆ get_personal_best_value()

double particle::get_personal_best_value ( )
inline

Definition at line 44 of file PSO.h.

44 {
46 };
double personal_best_value
Definition: PSO.h:66

◆ get_position()

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

Definition at line 28 of file PSO.h.

28 {
29 return position;
30 };

◆ get_value()

double particle::get_value ( )
inline

Definition at line 56 of file PSO.h.

56 {
57 return curr_value;
58 };
double curr_value
Definition: PSO.h:67

◆ get_velocity()

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

Definition at line 48 of file PSO.h.

48 {
49 return velocity;
50 };

◆ set_personal_best_position()

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

Definition at line 32 of file PSO.h.

32 {
33 personal_best_position = new_pos;
34 };

◆ set_personal_best_value()

void particle::set_personal_best_value ( const double  new_val)
inline

Definition at line 40 of file PSO.h.

40 {
41 personal_best_value = new_val;
42 };

◆ set_position()

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

Definition at line 24 of file PSO.h.

24 {
25 position = new_position;
26 };

◆ set_value()

void particle::set_value ( const double  val)
inline

Definition at line 59 of file PSO.h.

59 {
60 curr_value = val;
61 };

◆ set_velocity()

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

Definition at line 52 of file PSO.h.

52 {
53 velocity = new_velocity;
54 };

Member Data Documentation

◆ curr_value

double particle::curr_value
private

Definition at line 67 of file PSO.h.

◆ personal_best_position

std::vector<double> particle::personal_best_position
private

Definition at line 68 of file PSO.h.

◆ personal_best_value

double particle::personal_best_value
private

Definition at line 66 of file PSO.h.

◆ position

std::vector<double> particle::position
private

Definition at line 64 of file PSO.h.

◆ velocity

std::vector<double> particle::velocity
private

Definition at line 65 of file PSO.h.


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