antitheticSampling-class: Class '"antitheticSampling"'

Description Objects from the Class Slots Methods Author(s) References See Also Examples

Description

This class definition allows for the application of antithetic sampling to any "MonteCarloSampling" subclass object. Please see the vignette reference below for more details.

Objects from the Class

Objects can be created by calls of the form new("antitheticSampling", ...). However, an object constructor of the same name, antitheticSampling, has been provided and is the preferred method for creating objects that are ensured to be valid.

Slots

mcsObj:

Object of class "MonteCarloSampling": This is the original "MonteCarloSampling" subclass object based on the u.s random numbers found within the slot of this name within the object.

mcsAnti:

Object of class "MonteCarloSampling": This is the antithetic companion object to mcsObj that has been derived from the 1-u.s random numbers.

volEst:

Object of class "numeric": The sample mean volume estimate for the bole segment.

volVar:

Object of class "numeric": The within bole variance estimate of volEst.

ci.lo:

Object of class "numeric": The lower 1-alphaLevel confidence interval on the bole volume estimate.

ci.up:

Object of class "numeric": The upper 1-alphaLevel confidence interval on the bole volume estimate.

alphaLevel:

Object of class "numeric": The two-tailed alpha-level for confidence interval construction.

trueVol:

Object of class "numeric": The true volume for the stem segment being estimated (see segBnds in the "MonteCarloSampling" class definition).

relErrPct:

Object of class "numeric": The relative error in volume in percent.

description:

Object of class "character": A description of the object if desired (defaults are given for each class).

Methods

show

signature(object = "antitheticSampling"): print a summary of the object.

summary

signature(object = "antitheticSampling"): print a summary of the object.

Author(s)

Jeffrey H. Gove

References

Gove, J. H. 2013. Monte Carlo sampling methods in sampSurf. Package vignette.

See Also

The following subclasses and related via the mcsObj slot: MonteCarloSampling, crudeMonteCarlo, importanceSampling, controlVariate,

Examples

1
showClass("antitheticSampling")

sampSurf documentation built on March 5, 2021, 5:06 p.m.