big.matrix-class {bigmemory} | R Documentation |
The big.matrix
class is designed for matrices with
elements consisting of the C types double, integer, short, or char.
A big.matrix
acts much like a traditional R matrix, but helps protect
the user from many inadvertant memory-consuming pitfalls of traditional R
matrices and data frames. In Unix, they may also be used in shared memory.
Objects can be created by calls of the form new("big.matrix", ...)
.
The functions big.matrix()
and
shared.big.matrix()
are intended for the user.
address
:"externalptr"
points to the memory location of the C++ data structure.type
:"character"
can be one of "double"
, "integer"
, "short"
, or "char"
, using 8, 4, 2, and 1 bytes, respectively, per element.signature(x = "big.matrix", i = "numeric", j = "numeric", value = "ANY")
: ... signature(x = "big.matrix", i = "numeric", j = "character", value = "ANY")
: ... signature(x = "big.matrix", i = "numeric", j = "missing", value = "numeric")
: ... signature(x = "big.matrix", i = "missing", j = "numeric", value = "numeric")
: ... signature(x = "big.matrix", i = "missing", j = "character", value = "numeric")
: ... signature(x = "big.matrix", i = "missing", j = "missing", value = "numeric")
: ... signature(x = "big.matrix", i = "numeric", j = "numeric", drop = "missing")
: ... signature(x = "big.matrix", i = "numeric", j = "character", drop = "missing")
: ... signature(x = "big.matrix", i = "numeric", j = "missing", drop = "missing")
: ... signature(x = "big.matrix", i = "missing", j = "numeric", drop = "missing")
: ... signature(x = "big.matrix", i = "missing", j = "character", drop = "missing")
: ... signature(x = "big.matrix", i = "missing", j = "missing", drop = "missing")
: ... signature(x = "big.matrix", i = "missing", j = "logical", drop = "missing")
: ... signature(x = "big.matrix", i = "logical", j = "logical", drop = "missing")
: ... signature(x = "big.matrix", i = "logical", j = "missing", drop = "missing")
: ... signature(x = "big.matrix")
: returns the maximum of each column (or the specified columns, optionally). signature(x = "big.matrix")
: returns the mean of each column (or the specified columns, optionally). signature(x = "big.matrix")
: returns the min of each column (or the specified columns, optionally). signature(x = "big.matrix")
: returns the range of each column (or the specified columns, optionally). signature(x = "big.matrix")
: returns the standard deviation of each column (or the specified columns, optionally). signature(x = "big.matrix")
: returns the variance of each column (or the specified columns, optionally). signature(x = "big.matrix")
: this is only interesting if the big.matrix
is in shared memory. signature(x = "big.matrix")
: returns the dimension of the big.matrix
. signature(x = "big.matrix", value = "list")
: set the row and column names. signature(x = "big.matrix")
: get the row and column names. signature(x = "big.matrix")
: get the first 6 (or n
) rows. signature(x = "big.matrix")
: returns the maximum of all the values. signature(x = "big.matrix")
: returns the mean of all the values. signature(x = "big.matrix")
: returns the minimum of all the values.signature(x = "big.matrix")
: returns the number of columns. signature(x = "big.matrix")
: returns the number of rows. signature(x = "big.matrix")
: a traditional print()
is intentionally disabled, and returns head(x)
unless options()$bm.print.warning==FALSE
; in this case, print(x[,])
is the result, which could be very big! signature(x = "big.matrix")
: returns the range of all the values.signature(object = "big.matrix")
: produce a summary of each of the columns, similar (but not identical to) the traditional summary()
function. signature(x = "big.matrix")
: returns the last 6 (or n
) rows. signature(bigMat = "big.matrix", fileName = "character")
: produce an ASCII file from the big.matrix
. signature(x = "big.matrix")
: return TRUE
if the big.matrix
is in shared memory.signature(x = "big.matrix")
: return the type of the atomic elements of the big.matrix
.John W. Emerson and Michael J. Kane
showClass("big.matrix")