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

A uniform range of logarithmically scaled values (e.g. 1, 10, 100, 1000) More...

#include <log_range_param.h>

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

Public Member Functions

 LogRangeParam ()=default
 
 LogRangeParam (const std::string &n, real_t base, real_t min, real_t max, real_t stride)
 
void Validate () const override
 
OptimizationParamTypeGetCopy () const override
 
real_t GetValue (int n) const override
 
uint32_t GetNumElements () const override
 
 BDM_CLASS_DEF_OVERRIDE (LogRangeParam, 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 base = 10
 
real_t lower_bound = 0
 
real_t upper_bound = 0
 
real_t stride = 1
 
- Public Attributes inherited from bdm::OptimizationParamType
std::string param_name
 

Detailed Description

A uniform range of logarithmically scaled values (e.g. 1, 10, 100, 1000)

Definition at line 26 of file log_range_param.h.

Constructor & Destructor Documentation

◆ LogRangeParam() [1/2]

bdm::LogRangeParam::LogRangeParam ( )
default

◆ LogRangeParam() [2/2]

bdm::LogRangeParam::LogRangeParam ( const std::string &  n,
real_t  base,
real_t  min,
real_t  max,
real_t  stride 
)
inline

Definition at line 28 of file log_range_param.h.

Member Function Documentation

◆ BDM_CLASS_DEF_OVERRIDE()

bdm::LogRangeParam::BDM_CLASS_DEF_OVERRIDE ( LogRangeParam  ,
 
)

◆ GetCopy()

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

Implements bdm::OptimizationParamType.

Definition at line 46 of file log_range_param.h.

◆ GetNumElements()

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

Implements bdm::OptimizationParamType.

Definition at line 59 of file log_range_param.h.

◆ GetValue()

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

Implements bdm::OptimizationParamType.

Definition at line 51 of file log_range_param.h.

◆ Validate()

void bdm::LogRangeParam::Validate ( ) const
inlineoverridevirtual

Reimplemented from bdm::OptimizationParamType.

Definition at line 38 of file log_range_param.h.

Member Data Documentation

◆ base

real_t bdm::LogRangeParam::base = 10

Definition at line 64 of file log_range_param.h.

◆ lower_bound

real_t bdm::LogRangeParam::lower_bound = 0

Definition at line 66 of file log_range_param.h.

◆ stride

real_t bdm::LogRangeParam::stride = 1

Definition at line 70 of file log_range_param.h.

◆ upper_bound

real_t bdm::LogRangeParam::upper_bound = 0

Definition at line 68 of file log_range_param.h.


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