antitheticContainer-class {sampSurf}R Documentation

Class "antitheticContainer"

Description

This class allows one to store a collection of objects that are all of class "antitheticSampling."

Objects from the Class

Objects can be created by calls of the form new("antitheticContainer", ...). However, the actual constructor method (antitheticContainer) need never be called directly; instead, use the antitheticSampling constructor to create container objects of this class.

Slots

mcsObjs:

Object of class "list": A list of objects that must be of class "antitheticSampling."

stats:

Object of class "matrix": Summary statistics for the objects in slot mcsObjs.

description:

Object of class "character" A character description of the contents if desired.

Extends

Class "mcsContainer", directly.

Methods

No methods defined with class "antitheticContainer" in the signature. However, plot, show, summary and hist methods will work via inheritance.

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

antitheticContainer, antitheticSampling, mcsContainer.

Examples

showClass("antitheticContainer")

[Package sampSurf version 0.7-4 Index]