big.matrix-class {bigmemory}R Documentation

Class “big.matrix”.

Description

The big.matrix class is designed for matrices with elements of type 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. The objects may be allocated to shared memory, and if file backing is used they may exceed virtual memory in size. Sadly, 32-bit R constraints on Windows and many MacOS machines will be a limiting factor with file-backed matrices.

Objects from the Class

Objects can be created by calls of the form new("big.matrix", ...). The functions big.matrix(), shared.big.matrix(), and filebacked.big.matrix() are intended for the user.

Slots

address:
Object of class "externalptr" points to the memory location of the C++ data structure.

Methods

[<-
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 = "logical"): ...
[
signature(x = "big.matrix", i = "numeric", j = "numeric", drop = "logical"): ...
[
signature(x = "big.matrix", i = "numeric", j = "character", drop = "logical"): ...
[
signature(x = "big.matrix", i = "numeric", j = "missing", drop = "logical"): ...
[
signature(x = "big.matrix", i = "missing", j = "numeric", drop = "logical"): ...
[
signature(x = "big.matrix", i = "missing", j = "character", drop = "logical"): ...
[
signature(x = "big.matrix", i = "missing", j = "missing", drop = "logical"): ...
[
signature(x = "big.matrix", i = "missing", j = "logical", drop = "logical"): ...
[
signature(x = "big.matrix", i = "logical", j = "logical", drop = "logical"): ...
[
signature(x = "big.matrix", i = "logical", j = "missing", drop = "logical"): ...
colmax
signature(x = "big.matrix"): returns the maximum of each column (or the specified columns, optionally).
colmean
signature(x = "big.matrix"): returns the mean of each column (or the specified columns, optionally).
colmin
signature(x = "big.matrix"): returns the min of each column (or the specified columns, optionally).
colrange
signature(x = "big.matrix"): returns the range of each column (or the specified columns, optionally).
colsd
signature(x = "big.matrix"): returns the standard deviation of each column (or the specified columns, optionally).
colvar
signature(x = "big.matrix"): returns the variance of each column (or the specified columns, optionally).
binit
signature(x = "big.matrix"): calculates 1D and 2D binning.
describe
signature(x = "big.matrix"): this is only interesting if the big.matrix is in shared memory.
backingpath
signature(x = "big.matrix"): returns the backingpath of the big.matrix.
nebytes
signature(x = "big.matrix"): undocumented experimental functionality.
dim
signature(x = "big.matrix"): returns the dimension of the big.matrix.
dimnames<-
signature(x = "big.matrix", value = "list"): set the row and column names.
dimnames
signature(x = "big.matrix"): get the row and column names.
head
signature(x = "big.matrix"): get the first 6 (or n) rows.
max
signature(x = "big.matrix"): returns the maximum of all the values.
mean
signature(x = "big.matrix"): returns the mean of all the values.
min
signature(x = "big.matrix"): returns the minimum of all the values.
ncol
signature(x = "big.matrix"): returns the number of columns.
nrow
signature(x = "big.matrix"): returns the number of rows.
print
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!
range
signature(x = "big.matrix"): returns the range of all the values.
summary
signature(object = "big.matrix"): produce a summary of each of the columns, similar (but not identical to) the traditional summary() function.
tail
signature(x = "big.matrix"): returns the last 6 (or n) rows.
write.big.matrix
signature(bigMat = "big.matrix", fileName = "character"): produce an ASCII file from the big.matrix.
is.shared
signature(x = "big.matrix"): return TRUE if the big.matrix is in shared memory.
is.separated
signature(x = "big.matrix") : return TRUE if the big.matrix is organized as a separated column vectors.
typeof
signature(x = "big.matrix"): return the type of the atomic elements of the big.matrix.

Author(s)

John W. Emerson and Michael J. Kane

See Also

big.matrix

Examples

showClass("big.matrix")

[Package bigmemory version 3.10 Index]