0.1.26
Loading...
Searching...
No Matches
pyhelios.plant_architecture_params.RandomParameterFloat Class Reference

A float-valued parameter with a sampling distribution. More...

Detailed Description

A float-valued parameter with a sampling distribution.

Use the classmethod constructors (:meth:constant, :meth:uniform, :meth:normal, :meth:weibull) rather than constructing directly.

Definition at line 66 of file plant_architecture_params.py.

Public Member Functions

"RandomParameterFloat" constant (cls, float value)
 
"RandomParameterFloat" uniform (cls, float min_val, float max_val)
 
"RandomParameterFloat" normal (cls, float mean, float std_dev)
 
"RandomParameterFloat" weibull (cls, float shape, float scale)
 
Dict[str, Any] to_dict (self)
 
"RandomParameterFloat" from_dict (cls, Dict[str, Any] d)
 

Static Public Attributes

str distribution = "constant"
 
List parameters = field(default_factory=lambda: [0.0])
 

Member Function Documentation

◆ constant()

"RandomParameterFloat" pyhelios.plant_architecture_params.RandomParameterFloat.constant ( cls,
float value )

Definition at line 72 of file plant_architecture_params.py.

◆ from_dict()

"RandomParameterFloat" pyhelios.plant_architecture_params.RandomParameterFloat.from_dict ( cls,
Dict[str, Any] d )

Definition at line 99 of file plant_architecture_params.py.

◆ normal()

"RandomParameterFloat" pyhelios.plant_architecture_params.RandomParameterFloat.normal ( cls,
float mean,
float std_dev )

Definition at line 82 of file plant_architecture_params.py.

◆ to_dict()

Dict[str, Any] pyhelios.plant_architecture_params.RandomParameterFloat.to_dict ( self)

Definition at line 95 of file plant_architecture_params.py.

◆ uniform()

"RandomParameterFloat" pyhelios.plant_architecture_params.RandomParameterFloat.uniform ( cls,
float min_val,
float max_val )

Definition at line 76 of file plant_architecture_params.py.

◆ weibull()

"RandomParameterFloat" pyhelios.plant_architecture_params.RandomParameterFloat.weibull ( cls,
float shape,
float scale )

Definition at line 88 of file plant_architecture_params.py.

Member Data Documentation

◆ distribution

pyhelios.plant_architecture_params.RandomParameterFloat.distribution = "constant"
static

Definition at line 68 of file plant_architecture_params.py.

◆ parameters

List pyhelios.plant_architecture_params.RandomParameterFloat.parameters = field(default_factory=lambda: [0.0])
static

Definition at line 69 of file plant_architecture_params.py.


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