bdm::ParticleSwarmParam Struct Reference

#include <particle_swarm_param.h>

Inheritance diagram for bdm::ParticleSwarmParam:

Collaboration diagram for bdm::ParticleSwarmParam:

Public Member Functions
	ParticleSwarmParam ()=default
	ParticleSwarmParam (const std::string &name, real_t min, real_t max, real_t iv)
void	Validate () const override
OptimizationParamType *	GetCopy () const override
real_t	GetValue (int n) const override
uint32_t	GetNumElements () const override
	BDM_CLASS_DEF_OVERRIDE (ParticleSwarmParam, 1)
Public Member Functions inherited from bdm::OptimizationParamType
	OptimizationParamType ()=default
	OptimizationParamType (const std::string &name)
virtual	~OptimizationParamType ()=default
std::string	GetGroupName ()
std::string	GetParamName ()
	BDM_CLASS_DEF (OptimizationParamType, 1)

Public Attributes
real_t	lower_bound = 0
real_t	upper_bound = 0
real_t	initial_value = 1
Public Attributes inherited from bdm::OptimizationParamType
std::string	param_name

Detailed Description

A parameter type exclusively used for the Particle Swarm optimization algorithm Defines an initial value, and the lower and upper bound

Definition at line 27 of file particle_swarm_param.h.

Constructor & Destructor Documentation

ParticleSwarmParam() [1/2]

bdm::ParticleSwarmParam::ParticleSwarmParam ( )

default

ParticleSwarmParam() [2/2]

bdm::ParticleSwarmParam::ParticleSwarmParam ( const std::string &  name, real_t  min, real_t  max, real_t  iv  )

inline

Definition at line 29 of file particle_swarm_param.h.

Member Function Documentation

BDM_CLASS_DEF_OVERRIDE()

bdm::ParticleSwarmParam::BDM_CLASS_DEF_OVERRIDE	(	ParticleSwarmParam	,
		1
	)

GetCopy()

OptimizationParamType* bdm::ParticleSwarmParam::GetCopy ( ) const

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 46 of file particle_swarm_param.h.

GetNumElements()

uint32_t bdm::ParticleSwarmParam::GetNumElements ( ) const

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 57 of file particle_swarm_param.h.

GetValue()

real_t bdm::ParticleSwarmParam::GetValue ( int  n ) const

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 50 of file particle_swarm_param.h.

Validate()

void bdm::ParticleSwarmParam::Validate ( ) const

inlineoverridevirtual

Reimplemented from bdm::OptimizationParamType.

Definition at line 37 of file particle_swarm_param.h.

Member Data Documentation

initial_value

real_t bdm::ParticleSwarmParam::initial_value = 1

Definition at line 67 of file particle_swarm_param.h.

lower_bound

real_t bdm::ParticleSwarmParam::lower_bound = 0

Definition at line 63 of file particle_swarm_param.h.

upper_bound

real_t bdm::ParticleSwarmParam::upper_bound = 0

Definition at line 65 of file particle_swarm_param.h.

---

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

• core/multi_simulation/optimization_param_type/particle_swarm_param.h