valueInCompiledNimbleFunction {nimble} | R Documentation |
get or set value of member data from a compiled nimbleFunction using a multi-interface
Description
Most nimbleFunctions written for direct user interaction allow standard R-object-like access to member data using $
or `[[`
. However, sometimes compiled nimbleFunctions contained within other compiled nimbleFunctions are interfaced with a light-weight system called a multi-interface. valueInCompiledNimbleFunction
provides a way to get or set values in such cases.
Usage
valueInCompiledNimbleFunction(cnf, name, value)
Arguments
cnf |
Compiled nimbleFunction object |
name |
Name of the member data |
value |
If provided, the value to assign to the member data. If omitted, the value of the member data is returned. |
Details
The member data of a nimbleFunction are the objects created in setup
code that are used in run
code or other member functions.
Whether multi-interfaces are used for nested nimbleFunctions is controlled by the buildInterfacesForCompiledNestedNimbleFunctions
option in nimbleOptions
.
To see an example of a multi-interface, see samplerFunctions
in a compiled MCMC interface object.
Author(s)
Perry de Valpine