Runuran (version 0.21.0)

unuran.details: Information on a given "unuran" generator object

Description

Prints type of unuran generator, data used from distribution, parameter for algorithm, performance characteristic, and hints to adjust the performance of the generator. It also returns a list that contains some of these data. [Advanced] -- Print object.

Usage

unuran.details(unr, show=TRUE, return.list=FALSE, debug=FALSE)

Arguments

unr

an unuran object.

show

whether the data are printed on the console. (boolean)

return.list

whether some of the data are returned in a list. (boolean)

debug

if TRUE, store additional data in returned list. This might be useful to examine a method. (boolean)

Details

If show is TRUE then this routine prints data about the generator object to the console.

If return.list is TRUE then a list that contains some of these data is returned. This an experimental feature and components of the list may be extended on request.

The components of the returned list depend on the particular method. However, the following are common to all objects: [object Object],[object Object],[object Object]

In addition the following components may be available: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

See Also

unuran.

Examples

## Create a generator object
distr <- udnorm()
gen <- tdrd.new(distr)

## print data about object on console
unuran.details(gen)

## get list with some of these data
data <- unuran.details(gen,return.list=TRUE)