LocalObject {Umacs}R Documentation

Generate a LocalObject object for Umacs Sampler function

Description

Generates an object that is used to initialize an R object locally in a sampler function generated by Sampler. Usually a call to this function is not necessary, since it is implicitly done when the value of a named parameter in the argument list of Sampler is an R object but not a function, numeric object or an instance of the Umacs class Parameter.

Usage

LocalObject(x)

Arguments

x An R object (not a function)

Details

LocalObject is to be used only within the Sampler function call; the value of the argument (x) is made available (locally) in a sampling function that is built using the Umacs function Sampler.

The name of the parameter that will have the value (x) is not specified here, but only within the Sampler function call.

The components of a parameter vector initialized as Data parameters cannot be individually updated using Gibbs and Metropolis updating schemes.

For local functions, use the function LocalFunction instead.

Value

An object of class LocalObject, to be further processed by the Umacs function Sampler.

Note

LocalObject must be associated with a parameter name.

Components of vector parameters specified to be LocalObjects cannot be updated, but those specified to be Data can be updated.

Author(s)

Jouni Kerman <jouni@kerman.com>

References

Kerman, Jouni. Umacs: A Universal Markov Chain Sampler. Technical report, Columbia University, New York.

See Also

Umacs-package for an overview of the Umacs package.

Sampler for how to create a sampler function; see the vignette for details.

Package `rv'.


[Package Umacs version 0.924 Index]