File: sparseMatrix-class.Rd

package info (click to toggle)
rmatrix 0.95.5-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,732 kB
  • ctags: 2,028
  • sloc: ansic: 22,357; makefile: 74; sh: 28
file content (36 lines) | stat: -rw-r--r-- 1,298 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
\name{sparseMatrix-class}
\docType{class}
\alias{sparseMatrix-class}
\alias{show,sparseMatrix-method}
\alias{\%*\%,sparseMatrix,ddenseMatrix-method}
\alias{\%*\%,ddenseMatrix,sparseMatrix-method}
\alias{crossprod,sparseMatrix,ddenseMatrix-method}
\alias{crossprod,ddenseMatrix,sparseMatrix-method}
\title{Virtual Class "sparseMatrix" --- Mother of Sparse Matrices}
\description{Virtual Mother Class of All Sparse Matrices}
\section{Slots}{
  \code{Dim}, and \code{Dimnames}, see \code{\link{Matrix-class}}.
}
\section{Extends}{
  Class \code{"Matrix"}, directly.
}
\section{Methods}{
  \describe{
    \item{show}{\code{signature(object = "sparseMatrix")}: The
      \code{\link{show}} method for sparse matrices prints
      \emph{\dQuote{structural}} zeroes as \code{"."} or blank.}
  }
}
\note{
  In method selection for multiplication operations (i.e. \code{\%*\%}
  and the two-argument form of \code{\link[base]{crossprod}}) 
  the sparseMatrix class takes precedence in the sense that if one
  operand is a sparse matrix and the other is any type of dense matrix
  then the dense matrix is coerced to a \code{dgeMatrix} and the
  appropriate sparse matrix method is used.
}
%\author{Martin}
\examples{
showClass("sparseMatrix") ## and look at the help() of its subclasses
}
\keyword{classes}