EpiNow2 Stan Functions
Parameter Handlers

Functions for parameter management. More...

Collaboration diagram for Parameter Handlers:

Functions

real get_param (int id, array[] int params_fixed_lookup, array[] int params_variable_lookup, vector params_value, vector params)
 
vector get_param (int id, array[] int params_fixed_lookup, array[] int params_variable_lookup, vector params_value, matrix params)
 
void params_lp (vector params, array[] int prior_dist, vector prior_dist_params, vector params_lower, vector params_upper)
 

Description

Functions for parameter management.

Functions from params.stan for accessing, manipulating, and applying priors to model parameters.

Function Documentation

◆ get_param() [1/2]

vector get_param ( int id,
array[]int params_fixed_lookup,
array[]int params_variable_lookup,
vector params_value,
matrix params )

Get a parameter value from either fixed or variable parameters (matrix version)

This function is an overloaded version of get_param that works with a matrix of parameter values, returning a vector of parameter values for multiple samples.

Parameters
idParameter ID
params_fixed_lookupArray of fixed parameter lookup indices
params_variable_lookupArray of variable parameter lookup indices
params_valueVector of fixed parameter values
paramsMatrix of variable parameter values (rows are samples)
Returns
A vector of parameter values across samples

Definition at line 52 of file params.stan.

◆ get_param() [2/2]

real get_param ( int id,
array[]int params_fixed_lookup,
array[]int params_variable_lookup,
vector params_value,
vector params )

Parameter Handlers

This group of functions handles parameter access, retrieval, and prior specification in the model. Parameters can be either fixed (specified in advance) or variable (estimated during inference). Get a parameter value from either fixed or variable parameters

This function retrieves a parameter value based on its ID, checking first if it's a fixed parameter and then if it's a variable parameter.

Parameters
idParameter ID
params_fixed_lookupArray of fixed parameter lookup indices
params_variable_lookupArray of variable parameter lookup indices
params_valueVector of fixed parameter values
paramsVector of variable parameter values
Returns
The parameter value (scalar)

Definition at line 24 of file params.stan.

◆ params_lp()

void params_lp ( vector params,
array[]int prior_dist,
vector prior_dist_params,
vector params_lower,
vector params_upper )

Update log density for parameter priors

This function adds the log density contributions from parameter priors to the target, supporting multiple prior distribution types.

Parameters
paramsVector of parameter values
prior_distArray of prior distribution types (0: lognormal, 1: gamma, 2: normal)
prior_dist_paramsVector of prior distribution parameters
params_lowerVector of lower bounds for parameters
params_upperVector of upper bounds for parameters

Definition at line 80 of file params.stan.