SCM

SCM Repository

[matrix] Annotation of /pkg/man/sparseMatrix-class.Rd
ViewVC logotype

Annotation of /pkg/man/sparseMatrix-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1479 - (view) (download) (as text)

1 : maechler 676 \name{sparseMatrix-class}
2 :     \docType{class}
3 : maechler 956 \title{Virtual Class "sparseMatrix" --- Mother of Sparse Matrices}
4 : maechler 676 \alias{sparseMatrix-class}
5 : maechler 1472 %% Group methods
6 :     \alias{Arith,sparseMatrix,sparseMatrix-method}
7 :     \alias{Arith,sparseMatrix,numeric-method}
8 :     \alias{Arith,numeric,sparseMatrix-method}
9 :     \alias{Math,sparseMatrix-method}
10 :     %\alias{Math2,sparseMatrix,numeric-method}
11 :     %
12 :     \alias{coerce,ANY,sparseMatrix-method}
13 : maechler 956 \alias{-,sparseMatrix,missing-method}
14 : maechler 1472 \alias{diag,sparseMatrix-method}
15 : maechler 676 \alias{show,sparseMatrix-method}
16 : maechler 1290 \alias{colMeans,sparseMatrix-method}
17 :     \alias{colSums,sparseMatrix-method}
18 :     \alias{rowMeans,sparseMatrix-method}
19 :     \alias{rowSums,sparseMatrix-method}
20 : maechler 1271 % graph stuff
21 : maechler 871 \alias{coerce,graph,sparseMatrix-method}
22 : bates 1479 \alias{coerce,graph,CsparseMatrix-method}
23 : maechler 1271 \alias{coerce,graphAM,sparseMatrix-method}
24 : bates 1479 \alias{coerce,graphNEL,CsparseMatrix-method}
25 : maechler 908 \alias{coerce,sparseMatrix,graph-method}
26 :     \alias{coerce,sparseMatrix,graphNEL-method}
27 : maechler 1271 \alias{coerce,TsparseMatrix,graphNEL-method}
28 : maechler 908 \alias{coerce,dgTMatrix,graphNEL-method}
29 : maechler 1271 %
30 : maechler 676 \description{Virtual Mother Class of All Sparse Matrices}
31 :     \section{Slots}{
32 : maechler 925 \describe{
33 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
34 :     of the matrix - must be an integer vector with exactly two
35 :     non-negative values.}
36 :     \item{\code{Dimnames}:}{a list of length two - inherited from class
37 : maechler 1281 \code{Matrix}, see \code{\linkS4class{Matrix}}.}
38 : maechler 925 \item{\code{factors}:}{Object of class \code{"list"} - a list
39 :     of factorizations of the matrix. }
40 :     }
41 : maechler 676 }
42 :     \section{Extends}{
43 :     Class \code{"Matrix"}, directly.
44 :     }
45 :     \section{Methods}{
46 :     \describe{
47 :     \item{show}{\code{signature(object = "sparseMatrix")}: The
48 :     \code{\link{show}} method for sparse matrices prints
49 :     \emph{\dQuote{structural}} zeroes as \code{"."} or blank.}
50 :     }
51 :     }
52 : bates 685 \note{
53 :     In method selection for multiplication operations (i.e. \code{\%*\%}
54 : maechler 868 and the two-argument form of \code{\link[base]{crossprod}})
55 : bates 685 the sparseMatrix class takes precedence in the sense that if one
56 :     operand is a sparse matrix and the other is any type of dense matrix
57 :     then the dense matrix is coerced to a \code{dgeMatrix} and the
58 :     appropriate sparse matrix method is used.
59 :     }
60 : maechler 676 %\author{Martin}
61 :     \examples{
62 :     showClass("sparseMatrix") ## and look at the help() of its subclasses
63 :     }
64 :     \keyword{classes}

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge