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

#include <set_param.h>

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

Public Member Functions

 SetParam ()=default
 
 SetParam (const std::string &name, const std::vector< real_t > v)
 
OptimizationParamTypeGetCopy () const override
 
size_t size () const
 
real_t at (size_t n) const
 
uint32_t GetNumElements () const override
 
real_t GetValue (int n) const override
 
 BDM_CLASS_DEF_OVERRIDE (SetParam, 1)
 
- Public Member Functions inherited from bdm::OptimizationParamType
 OptimizationParamType ()=default
 
 OptimizationParamType (const std::string &name)
 
virtual ~OptimizationParamType ()=default
 
virtual void Validate () const
 
std::string GetGroupName ()
 
std::string GetParamName ()
 
 BDM_CLASS_DEF (OptimizationParamType, 1)
 

Public Attributes

std::vector< real_tvalues
 
- Public Attributes inherited from bdm::OptimizationParamType
std::string param_name
 

Detailed Description

A set of values (e.g. [-12, 3.2, 43, 98]) All values are interpreted as real_t precision floating point types

Definition at line 27 of file set_param.h.

Constructor & Destructor Documentation

◆ SetParam() [1/2]

bdm::SetParam::SetParam ( )
default

◆ SetParam() [2/2]

bdm::SetParam::SetParam ( const std::string &  name,
const std::vector< real_t v 
)
inline

Definition at line 29 of file set_param.h.

Member Function Documentation

◆ at()

real_t bdm::SetParam::at ( size_t  n) const
inline

Definition at line 37 of file set_param.h.

◆ BDM_CLASS_DEF_OVERRIDE()

bdm::SetParam::BDM_CLASS_DEF_OVERRIDE ( SetParam  ,
 
)

◆ GetCopy()

OptimizationParamType* bdm::SetParam::GetCopy ( ) const
inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 32 of file set_param.h.

◆ GetNumElements()

uint32_t bdm::SetParam::GetNumElements ( ) const
inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 39 of file set_param.h.

◆ GetValue()

real_t bdm::SetParam::GetValue ( int  n) const
inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 40 of file set_param.h.

◆ size()

size_t bdm::SetParam::size ( ) const
inline

Definition at line 36 of file set_param.h.

Member Data Documentation

◆ values

std::vector<real_t> bdm::SetParam::values

Definition at line 42 of file set_param.h.


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