highprecisionpso::VelocityAdjustment Class Referenceabstract

This class is an abstract class for processing the velocity adjustment after the position update of each particle. More...

#include <velocity_adjustment.h>

Inheritance diagram for highprecisionpso::VelocityAdjustment:

Public Member Functions

virtual ~VelocityAdjustment ()
 The Destructor. More...
 
virtual void AdjustVelocity (Particle *p, std::vector< bool > adjust_dimensions, std::vector< mpf_t * > old_position)=0
 Adjusts the velocity of a particle after the position update is finished. More...
 
virtual std::string GetName ()=0
 Returns a string representation of this object. More...
 

Detailed Description

This class is an abstract class for processing the velocity adjustment after the position update of each particle.

Constructor & Destructor Documentation

virtual highprecisionpso::VelocityAdjustment::~VelocityAdjustment ( )
virtual

The Destructor.

Member Function Documentation

virtual void highprecisionpso::VelocityAdjustment::AdjustVelocity ( Particle p,
std::vector< bool >  adjust_dimensions,
std::vector< mpf_t * >  old_position 
)
pure virtual

Adjusts the velocity of a particle after the position update is finished.

The specific behavior depends on the implementing subclass.

Parameters
pThe particle, which should be updated.
adjust_dimensionsMarks the dimensions, which should be adjusted with the value true.
old_positionThe previous position of the particle.

Implemented in highprecisionpso::VelocityAdjustmentDeterministicBack, highprecisionpso::VelocityAdjustmentAdjust, highprecisionpso::VelocityAdjustmentNone, highprecisionpso::VelocityAdjustmentRandomBack, and highprecisionpso::VelocityAdjustmentZero.

virtual std::string highprecisionpso::VelocityAdjustment::GetName ( )
pure virtual

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