bdm::RangeParam Struct Reference

#include <range_param.h>

Inheritance diagram for bdm::RangeParam:

Collaboration diagram for bdm::RangeParam:

Public Member Functions
	RangeParam ()=default
	RangeParam (const std::string &name, real_t min, real_t max, real_t stride)
void	Validate () const override
OptimizationParamType *	GetCopy () const override
real_t	GetValue (int n) const override
uint32_t	GetNumElements () const override
	BDM_CLASS_DEF_OVERRIDE (RangeParam, 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	stride = 1
Public Attributes inherited from bdm::OptimizationParamType
std::string	param_name

Detailed Description

A uniform range of values (e.g. [1,2,3,4,5]) All values are interpreted as real_t precision floating point types

Definition at line 28 of file range_param.h.

Constructor & Destructor Documentation

RangeParam() [1/2]

bdm::RangeParam::RangeParam ( )

default

RangeParam() [2/2]

bdm::RangeParam::RangeParam ( const std::string &  name, real_t  min, real_t  max, real_t  stride  )

inline

Definition at line 30 of file range_param.h.

Member Function Documentation

BDM_CLASS_DEF_OVERRIDE()

bdm::RangeParam::BDM_CLASS_DEF_OVERRIDE	(	RangeParam	,
		1
	)

GetCopy()

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

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 46 of file range_param.h.

GetNumElements()

uint32_t bdm::RangeParam::GetNumElements ( ) const

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 58 of file range_param.h.

GetValue()

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

inlineoverridevirtual

Implements bdm::OptimizationParamType.

Definition at line 51 of file range_param.h.

Validate()

void bdm::RangeParam::Validate ( ) const

inlineoverridevirtual

Reimplemented from bdm::OptimizationParamType.

Definition at line 38 of file range_param.h.

Member Data Documentation

lower_bound

real_t bdm::RangeParam::lower_bound = 0

Definition at line 63 of file range_param.h.

stride

real_t bdm::RangeParam::stride = 1

Definition at line 67 of file range_param.h.

upper_bound

real_t bdm::RangeParam::upper_bound = 0

Definition at line 65 of file range_param.h.

---

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

• core/multi_simulation/optimization_param_type/range_param.h