API Reference
SimulationParameters
Missing docstring for AbstractParameter
. Check Documenter's build log for details.
SimulationParameters.AbstractParameters
— Type(par::AbstractParameters)(kw...)
This functor is used to override the parameters at function call
Missing docstring for AbstractParametersVector
. Check Documenter's build log for details.
Missing docstring for BadParameterException
. Check Documenter's build log for details.
SimulationParameters.Entry
— TypeEntry{T}(units::String, description::String; default::Union{Missing,T}=missing) where T
Defines a entry parameter
Missing docstring for InexistentParametersFieldException
. Check Documenter's build log for details.
Missing docstring for NotsetParameterException
. Check Documenter's build log for details.
Missing docstring for OptParameter
. Check Documenter's build log for details.
Missing docstring for ParametersVector
. Check Documenter's build log for details.
SimulationParameters.Switch
— TypeSwitch{T}(options::AbstractDict{<:Any,SwitchOption}, units::String, description::String; default=missing) where {T}
Defines a switch parameter
Missing docstring for SwitchOption
. Check Documenter's build log for details.
SimulationParameters.dict2par!
— Functiondict2par!(dct::AbstractDict, par::AbstractParameters)
Convert dictionary to AbstractParameters
SimulationParameters.float_bounds
— Functionfloat_bounds(parameter::AbstractParameter)
Returns optimization bounds of a parameter (if it has one)
SimulationParameters.json2par
— Functionjson2par(filename::AbstractString, par_data::AbstractParameters)
Loads AbstractParameters from JSON
SimulationParameters.jstr2par
— Functionjstr2par(json_string::String, par_data::AbstractParameters)
Loads AbstractParameters from JSON string
SimulationParameters.nominal_values
— Functionnominal_values(parameter::AbstractParameter)
Returns nominal value of an optimization parameter (if it has one)
SimulationParameters.opt_labels
— Functionopt_labels(parameters::AbstractParameters)
Returns vector with optimization parameter label(s)
SimulationParameters.opt_parameters
— Functionopt_parameters(parameters::AbstractParameters, optimization_vector::Vector{AbstractParameter}=AbstractParameter[])
Pack the optimization parameters contained in a high-level parameters
AbstractParameters into a optimization_values
vector
SimulationParameters.par2dict
— Functionpar2dict(par::AbstractParameters)
Convert AbstractParameters to dictionary
SimulationParameters.par2dict!
— Functionpar2dict!(par::AbstractParameters, dct::AbstractDict)
Convert AbstractParameters to dictionary
SimulationParameters.par2json
— Functionpar2json(@nospecialize(par::AbstractParameters), filename::String; kw...)
Save AbstractParameters to JSON
NOTE: kw arguments are passed to JSON.print
SimulationParameters.par2jstr
— Functionpar2jstr(@nospecialize(par::AbstractParameters); indent::Int=1, kw...)
Returns JSON serialization of AbstractParameters
SimulationParameters.par2yaml
— Functionpar2yaml(@nospecialize(par::AbstractParameters), filename::String; kw...)
Save AbstractParameters to YAML
NOTE: kw arguments are passed to YAML.print
Missing docstring for par2ystr
. Check Documenter's build log for details.
SimulationParameters.parameters_from_opt!
— Functionparameters_from_opt!(parameters::AbstractParameters, optimization_values::AbstractVector)
Unpack a optimization_values
vector into a high-level parameters
AbstractParameters
Base.rand
— Functionrand!(parameters::AbstractParameters)
Generates a new AbstractParameters with randomized OptParameters
Base.rand(parameters::AbstractParameters, field::Symbol)
Generates a new random sample within the OptParameter distribution
Base.rand(parameter::AbstractParameter)
Generates a new random sample within the OptParameter distribution
SimulationParameters.rand!
— Functionrand!(parameters::AbstractParameters)
Randomizes all OptParameters in a AbstractParameters
rand!(parameters::AbstractParameters, field::Symbol)
Generates a new random sample within the OptParameter distribution and updates the parameter value
rand!(parameter::AbstractParameter)
Generates a new random sample within the OptParameter distribution and updates the parameter value
Missing docstring for set_new_base!
. Check Documenter's build log for details.
Missing docstring for setup_parameters!
. Check Documenter's build log for details.
Missing docstring for show_modified
. Check Documenter's build log for details.
SimulationParameters.yaml2par
— Functionyaml2par(filename::AbstractString, par_data::AbstractParameters)
Loads AbstractParameters from YAML
SimulationParameters.ystr2par
— Functionystr2par(yaml_string::String, par_data::AbstractParameters)
Loads AbstractParameters from YAML string
SimulationParameters.:↔
— Function↔(x::Real, r::AbstractVector)
"leftrightarrow" unicode constructor for OptParameterRange
↔(x::Real, r::AbstractVector)
"leftrightarrow" unicode constructor for OptParameterChoice
↔(x::Real, r::AbstractVector)
"leftrightarrow" unicode constructor for OptParameterFunction