1.3.49
 
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
RandomParameter_float Struct Reference

Random architecture model parameter value of type float. More...

#include <PlantArchitecture.h>

Public Member Functions

 RandomParameter_float ()
 Constructor initializing to a constant default value of 0.
 
 RandomParameter_float (float val)
 Constructor initializing to a constant value.
 
 RandomParameter_float (std::minstd_rand0 *rand_generator)
 Constructor initializing the random number generator.
 
void initialize (float a_val, std::minstd_rand0 *rand_generator)
 
void initialize (std::minstd_rand0 *rand_generator)
 
RandomParameter_float & operator= (float a)
 
void uniformDistribution (float minval, float maxval)
 
void normalDistribution (float mean, float std_dev)
 
void weibullDistribution (float shape, float scale)
 
float val ()
 
float resample ()
 

Data Fields

std::string distribution
 
std::vector< float > distribution_parameters
 

Detailed Description

Random architecture model parameter value of type float.

Definition at line 34 of file PlantArchitecture.h.

Constructor & Destructor Documentation

◆ RandomParameter_float() [1/3]

RandomParameter_float::RandomParameter_float ( )
inlineexplicit

Constructor initializing to a constant default value of 0.

In order to make this a randomly varying parameter, the initialize() method must be called to set the random number generator.

Definition at line 40 of file PlantArchitecture.h.

◆ RandomParameter_float() [2/3]

RandomParameter_float::RandomParameter_float ( float  val)
inlineexplicit

Constructor initializing to a constant value.

In order to make this a randomly varying parameter, the initialize() method must be called to set the random number generator.

Definition at line 51 of file PlantArchitecture.h.

◆ RandomParameter_float() [3/3]

RandomParameter_float::RandomParameter_float ( std::minstd_rand0 *  rand_generator)
inlineexplicit

Constructor initializing the random number generator.

Parameters
[in]rand_generatorPointer to a random number generator. Note: it is recommended to use the random number generator from the Context, which can be retrieved using the getContextRandomGenerator() method.

Definition at line 62 of file PlantArchitecture.h.

Member Function Documentation

◆ initialize() [1/2]

void RandomParameter_float::initialize ( float  a_val,
std::minstd_rand0 *  rand_generator 
)
inline

Definition at line 69 of file PlantArchitecture.h.

◆ initialize() [2/2]

void RandomParameter_float::initialize ( std::minstd_rand0 *  rand_generator)
inline

Definition at line 76 of file PlantArchitecture.h.

◆ normalDistribution()

void RandomParameter_float::normalDistribution ( float  mean,
float  std_dev 
)
inline

Definition at line 99 of file PlantArchitecture.h.

◆ operator=()

RandomParameter_float & RandomParameter_float::operator= ( float  a)
inline

Definition at line 83 of file PlantArchitecture.h.

◆ resample()

float RandomParameter_float::resample ( )
inline

Definition at line 118 of file PlantArchitecture.h.

◆ uniformDistribution()

void RandomParameter_float::uniformDistribution ( float  minval,
float  maxval 
)
inline

Definition at line 90 of file PlantArchitecture.h.

◆ val()

float RandomParameter_float::val ( )
inline

Definition at line 111 of file PlantArchitecture.h.

◆ weibullDistribution()

void RandomParameter_float::weibullDistribution ( float  shape,
float  scale 
)
inline

Definition at line 105 of file PlantArchitecture.h.

Field Documentation

◆ distribution

std::string RandomParameter_float::distribution

Definition at line 138 of file PlantArchitecture.h.

◆ distribution_parameters

std::vector<float> RandomParameter_float::distribution_parameters

Definition at line 139 of file PlantArchitecture.h.

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