FIMS  v0.8.0
Loading...
Searching...
No Matches
Parameter Class Reference

An Rcpp interface that defines the Parameter class. More...

#include <rcpp_interface_base.hpp>

Public Member Functions

 Parameter (double value, double min, double max, std::string estimation_type)
 The constructor for initializing a parameter.
 
 Parameter (const Parameter &other)
 The constructor for initializing a parameter.
 
Parameteroperator= (const Parameter &right)
 The constructor for initializing a parameter.
 
 Parameter (double value)
 The constructor for initializing a parameter.
 
 Parameter ()
 The constructor for initializing a parameter.
 

Public Attributes

uint32_t id_m
 The local ID of the Parameter object.
 
double initial_value_m = 0.0
 The initial value of the parameter.
 
double final_value_m = 0.0
 The final value of the parameter.
 
double uncertainty_m = -999.0
 The standard error of the parameter estimate, where the default is -999.0.
 
double min_m = -std::numeric_limits<double>::infinity()
 The minimum possible parameter value, where the default is negative infinity.
 
double max_m = std::numeric_limits<double>::infinity()
 The maximum possible parameter value, where the default is positive infinity.
 
SharedString estimation_type_m = SharedString("constant")
 A string indicating the estimation type. Options are: constant, fixed_effects, or random_effects, where the default is constant.
 

Static Public Attributes

static uint32_t id_g = 0
 The static ID of the Parameter object.
 

Detailed Description

An Rcpp interface that defines the Parameter class.

An Rcpp interface class that defines the interface between R and C++ for a parameter type.

Constructor & Destructor Documentation

◆ Parameter()

Parameter::Parameter ( )
inline

The constructor for initializing a parameter.

Set value to 0 when there is no input value.

Member Data Documentation

◆ id_g

uint32_t Parameter::id_g = 0
static

The static ID of the Parameter object.

The unique ID for the variable map that points to a fims::Vector.


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