bigmemory (version 4.6.4)

big.matrix.descriptor-class: Class "big.matrix.descriptor"

Description

An object of this class contains necessary and sufficient information to ``attach'' a shared or filebacked big.matrix.

Usage

# S4 method for character
attach.resource(obj, ...)
# S4 method for big.matrix.descriptor
attach.resource(obj, ...)

Arguments

obj

The filename of the descriptor for a filebacked matrix, assumed to be in the directory specified

...

possibly path which gives the path where the descriptor and/or filebacking can be found.

Objects from the Class

Objects should not be created by calls of the form new("big.matrix.descriptor", ...), but should use the describe function.

Slots

description:

Object of class "list"; details omitted.

Extends

Class "descriptor", directly.

Methods

attach.resource

signature(obj = "big.matrix.descriptor"): ...

sub.big.matrix

signature(x = "big.matrix.descriptor"): ...

Author

John W. Emerson and Michael J. Kane

References

Other types of descriptors are defined in package synchronicity.

See Also

See also attach.big.matrix.

Examples

showClass("big.matrix.descriptor")