splr_constructor: Sparse Plus Low-Rank Matrices

splrMatrix-classR Documentation

Sparse Plus Low-Rank Matrices

Description

An "S4" class for efficient computation with sparse plus low-rank matrices. Stores sparse plus low-rank matrices (e.g. from matrix factorization or centering graphs) of the form x + a %*% t(b) for faster computation.

Usage

splr(x, a = NULL, b = NULL, rank = NULL, dimnames = list(NULL, NULL), ...)

## S4 method for signature 'Matrix,Matrix,Matrix'
splr(x, a = NULL, b = NULL, rank = NULL, dimnames = list(NULL, NULL), ...)

Arguments

x

as in "Matrix"

a

as in "Matrix"

b

as in "Matrix"

rank

rank of the matrix to be factorized.

dimnames

optional - the list of names for the matrix

...

as in "Matrix"

Value

splrMatrix object

splrMatrix object

Slots

x

a sparse matrix

a

a low-rank factor or a matrix

b

optional. a low-rank factor for a %*% t(b). if b is not provided, a will be factorized using irlba provided factorize = TRUE

See Also

Methods are documented in splrMatrix_method. Other relevant methods are splr_sparse_plus_constant and


dpmcsuss/iGraphMatch documentation built on May 22, 2024, 8:52 p.m.