getBound: Get value of bound of a stochastic node in a model

View source: R/nimbleFunction_Rexecution.R

getBoundR Documentation

Get value of bound of a stochastic node in a model

Description

Get the value of the lower or upper bound for a single stochastic node in a model.

Usage

getBound(model, node, bound, nodeFunctionIndex)

Arguments

model

A NIMBLE model object

node

The name of a stochastic node in the model

bound

Either 'lower' or 'upper' indicating the desired bound for the node

nodeFunctionIndex

For internal NIMBLE use only

Details

Standard usage is as a method of a model, in the form model$getBound(node, bound), but the usage as a simple function with the model as the first argument as above is also allowed.

For nodes that do not involve truncation of the distribution this will return the lower or upper bound of the distribution, which may be a constant or for a limited number of distributions a parameter or functional of a parameter (at the moment in NIMBLE, the only case where a bound is a parameter is for the uniform distribution. For nodes that are truncated, this will return the desired bound, which may be a functional of other quantities in the model or may be a constant.


nimble documentation built on March 18, 2022, 8:03 p.m.