antitheticContainer: Generate Objects of Class "'antitheticContainer'"

Description Usage Arguments Details Value Note Author(s) References See Also Examples

Description

The methods for this function will allow the creation of valid "antitheticContainer" class objects. Please note that it is preferable to use the antitheticSampling constructor method directly with an "mcsContainer" object to create a valid collection. Please see the vignette below for detailed examples. See also antitheticContainer-methods for method details.

Usage

1

Arguments

object

The signature object for the generic.

...

Just gobbled presently.

Details

The vignette below gives examples on creating “antitheticContainer” objects for each of the Monte Carlo subsampling methods available in sampSurf by passing a “mcsContainer” object to the antitheticSampling constructor. Please use this rather than calling the current constructor directly.

Value

A valid object of class "antitheticContainer."

Note

Please note that this is not a completely functional container class in the traditional sense at present as it does not have replacement, deletion, or addition functions. If you need to do any of these operations, perform them on the list object (in the mcsObjs slot) and then recreate the container. If the object is not re-built after, e.g., deletion, the summary statistics will be incorrect.

Author(s)

Jeffrey H. Gove

References

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

See Also

antitheticSampling

Examples

1
2
3
4
5
6
sTrees = standingTrees(5, startSeed = 12)
sTrees.cmc = crudeMonteCarlo(sTrees, n.s = 10)
sTrees.anti = antitheticSampling(sTrees.cmc)
sTrees.anti
print(sTrees.anti@stats, digits = 4) #compare with cmc below
print(sTrees.cmc@stats, digits = 4)

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