R/MatrixExtra.R

In MatrixExtra: Extra Methods for Sparse Matrices

#' @useDynLib MatrixExtra, .registration=TRUE
#' @importFrom Rcpp evalCpp
#' @import Matrix
#' @import methods

#' @title MatrixExtra package
#' @description Additional methods for the sparse matrices and sparse vector classes
#' from the `Matrix` package, with an emphasis on the CSR (compressed sparse row) format
#' (a.k.a. "RsparseMatrix" in `Matrix` parlance).
#'
#' This package provides, among others:\itemize{
#' \item Fast and multi-threaded matrix multiplications for various combinations of
#' `<sparse,dense>` and `<dense,sparse>` types (see \link[MatrixExtra]{matmult}),
#' including the dense `float32` types from the `float` package
#' (see \link[float]{float-package}).
#' \item Operations that work efficiently in the CSR format, such as concatenating by rows
#' (see \link[MatrixExtra]{rbind2-method}) or selecting rows (see \link[MatrixExtra]{slice}).
#' \item Convenience conversion functions for the different sparse matrix types
#' (see \link[MatrixExtra]{conversions}).
#' \item Overloaded operators such as "+" or "*" for many combinations of
#' `<RsparseMatrix,RsparseMatrix>`, `<RsparseMatrix,TsparseMatrix>`,
#' `<RsparseMatrix,matrix>`, and `<RsparseMatrix,scalar>` (see \link[MatrixExtra]{operators}).
#' \item Overloaded mathematical functions that work only on the non-zero entries of matrices
#' (see \link[MatrixExtra]{mathematical-functions}).
#' \item Fast transposes which change the storage format (see \link[MatrixExtra]{t_shallow}).
#' \item Utility functions for sparse matrices (see e.g.
#' \link[MatrixExtra]{sort_sparse_indices} and \link[MatrixExtra]{remove_sparse_zeros}).
#' \item Faster replacements for many methods from `Matrix` for all the sparse formats
#' (COO, CSR, CSC), such as `[` (\link[MatrixExtra]{slice}), addition (`+`),
#' elementwise multiplication (`*`), among others (see \link[MatrixExtra]{operators}).
#' \item Convenience functions for sparse objects, such as \link[MatrixExtra]{mapSparse},
#' \link[MatrixExtra]{emptySparse}, and a shorter \link[MatrixExtra]{show} method for sparse objects.
#' }
#' 
#' \bold{Important:} `MatrixExtra` modifies some important behaviors from the
#' `Matrix` library, which might cause some functions from `Matrix` or other
#' packages to stop working under the default options of `MatrixExtra`.
#' See \link{MatrixExtra-options} for details.
#' @docType package
#' @name MatrixExtra
#' @keywords package
"_PACKAGE"