BioDynaMo  v1.03.58-27764645
Public Member Functions | Public Attributes | List of all members
bdm::OptimizationParamType Struct Referenceabstract

An interface for creating different types of optimization parameters. More...

#include <optimization_param_type.h>

Inheritance diagram for bdm::OptimizationParamType:
[legend]
Collaboration diagram for bdm::OptimizationParamType:
[legend]

Public Member Functions

 OptimizationParamType ()=default
 
 OptimizationParamType (const std::string &name)
 
virtual ~OptimizationParamType ()=default
 
virtual OptimizationParamTypeGetCopy () const =0
 
virtual uint32_t GetNumElements () const =0
 
virtual real_t GetValue (int n) const =0
 
virtual void Validate () const
 
std::string GetGroupName ()
 
std::string GetParamName ()
 
 BDM_CLASS_DEF (OptimizationParamType, 1)
 

Public Attributes

std::string param_name
 

Detailed Description

An interface for creating different types of optimization parameters.

Definition at line 27 of file optimization_param_type.h.

Constructor & Destructor Documentation

◆ OptimizationParamType() [1/2]

bdm::OptimizationParamType::OptimizationParamType ( )
default

◆ OptimizationParamType() [2/2]

bdm::OptimizationParamType::OptimizationParamType ( const std::string &  name)
inlineexplicit

Definition at line 29 of file optimization_param_type.h.

◆ ~OptimizationParamType()

virtual bdm::OptimizationParamType::~OptimizationParamType ( )
virtualdefault

Member Function Documentation

◆ BDM_CLASS_DEF()

bdm::OptimizationParamType::BDM_CLASS_DEF ( OptimizationParamType  ,
 
)

◆ GetCopy()

virtual OptimizationParamType* bdm::OptimizationParamType::GetCopy ( ) const
pure virtual

◆ GetGroupName()

std::string bdm::OptimizationParamType::GetGroupName ( )
inline

Definition at line 40 of file optimization_param_type.h.

◆ GetNumElements()

virtual uint32_t bdm::OptimizationParamType::GetNumElements ( ) const
pure virtual

◆ GetParamName()

std::string bdm::OptimizationParamType::GetParamName ( )
inline

Definition at line 46 of file optimization_param_type.h.

◆ GetValue()

virtual real_t bdm::OptimizationParamType::GetValue ( int  n) const
pure virtual

◆ Validate()

virtual void bdm::OptimizationParamType::Validate ( ) const
inlinevirtual

Reimplemented in bdm::LogRangeParam, bdm::ParticleSwarmParam, and bdm::RangeParam.

Definition at line 36 of file optimization_param_type.h.

Member Data Documentation

◆ param_name

std::string bdm::OptimizationParamType::param_name

Definition at line 52 of file optimization_param_type.h.


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