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 1737 - (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 : maechler 1665 \alias{Compare,sparseMatrix,sparseMatrix-method}
7 : maechler 1472 \alias{Arith,sparseMatrix,sparseMatrix-method}
8 :     \alias{Arith,sparseMatrix,numeric-method}
9 :     \alias{Arith,numeric,sparseMatrix-method}
10 :     \alias{Math,sparseMatrix-method}
11 :     %\alias{Math2,sparseMatrix,numeric-method}
12 : maechler 1654 \alias{Ops,diagonalMatrix,sparseMatrix-method}
13 :     \alias{Ops,sparseMatrix,diagonalMatrix-method}
14 : maechler 1472 %
15 : maechler 1708 \alias{cbind2,sparseMatrix,sparseMatrix-method}
16 :     \alias{cbind2,sparseMatrix,matrix-method}
17 :     \alias{cbind2,matrix,sparseMatrix-method}
18 :     \alias{cbind2,sparseMatrix,numeric-method}
19 :     \alias{cbind2,numeric,sparseMatrix-method}
20 :     \alias{rbind2,sparseMatrix,sparseMatrix-method}
21 :     \alias{rbind2,sparseMatrix,matrix-method}
22 :     \alias{rbind2,matrix,sparseMatrix-method}
23 :     \alias{rbind2,sparseMatrix,numeric-method}
24 :     \alias{rbind2,numeric,sparseMatrix-method}
25 :     %
26 : maechler 1472 \alias{coerce,ANY,sparseMatrix-method}
27 : maechler 956 \alias{-,sparseMatrix,missing-method}
28 : maechler 1472 \alias{diag,sparseMatrix-method}
29 : maechler 676 \alias{show,sparseMatrix-method}
30 : maechler 1290 \alias{colMeans,sparseMatrix-method}
31 :     \alias{colSums,sparseMatrix-method}
32 :     \alias{rowMeans,sparseMatrix-method}
33 :     \alias{rowSums,sparseMatrix-method}
34 : maechler 1271 % graph stuff
35 : maechler 871 \alias{coerce,graph,sparseMatrix-method}
36 : bates 1479 \alias{coerce,graph,CsparseMatrix-method}
37 : maechler 1271 \alias{coerce,graphAM,sparseMatrix-method}
38 : bates 1479 \alias{coerce,graphNEL,CsparseMatrix-method}
39 : maechler 1565 \alias{coerce,graphNEL,TsparseMatrix-method}
40 : maechler 908 \alias{coerce,sparseMatrix,graph-method}
41 :     \alias{coerce,sparseMatrix,graphNEL-method}
42 : maechler 1271 \alias{coerce,TsparseMatrix,graphNEL-method}
43 : maechler 908 \alias{coerce,dgTMatrix,graphNEL-method}
44 : maechler 1271 %
45 : maechler 676 \description{Virtual Mother Class of All Sparse Matrices}
46 :     \section{Slots}{
47 : maechler 925 \describe{
48 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
49 :     of the matrix - must be an integer vector with exactly two
50 :     non-negative values.}
51 :     \item{\code{Dimnames}:}{a list of length two - inherited from class
52 : maechler 1281 \code{Matrix}, see \code{\linkS4class{Matrix}}.}
53 : maechler 925 \item{\code{factors}:}{Object of class \code{"list"} - a list
54 :     of factorizations of the matrix. }
55 :     }
56 : maechler 676 }
57 :     \section{Extends}{
58 :     Class \code{"Matrix"}, directly.
59 :     }
60 :     \section{Methods}{
61 :     \describe{
62 :     \item{show}{\code{signature(object = "sparseMatrix")}: The
63 :     \code{\link{show}} method for sparse matrices prints
64 : maechler 1737 \emph{\dQuote{structural}} zeroes as \code{"."} using the
65 :     non-exported \code{prSpMatrix} function which allows further
66 :     customization such as replacing \code{"."} by \code{" "} (blank).
67 :    
68 :     Note that \code{\link{options}(max.print)} will influence how many
69 :     entries of large matrices are printed at all.}
70 : maechler 676 }
71 :     }
72 : bates 685 \note{
73 :     In method selection for multiplication operations (i.e. \code{\%*\%}
74 : maechler 868 and the two-argument form of \code{\link[base]{crossprod}})
75 : bates 685 the sparseMatrix class takes precedence in the sense that if one
76 :     operand is a sparse matrix and the other is any type of dense matrix
77 :     then the dense matrix is coerced to a \code{dgeMatrix} and the
78 :     appropriate sparse matrix method is used.
79 :     }
80 : maechler 676 %\author{Martin}
81 :     \examples{
82 :     showClass("sparseMatrix") ## and look at the help() of its subclasses
83 : maechler 1737 M <- Matrix(0, 10000, 100)
84 :     M[1,1] <- M[2,3] <- 3.14
85 :     M
86 :     \dontshow{% show() was slow in 0.9975-8 because of slow adjust="fancy"
87 :     op <- options(max.print = 25000, width = 80)
88 :     sink(print(tempfile()))
89 :     stopifnot((st <- system.time(show(M)))[1] < 1.0) # only 0.09 on cmath-3
90 :     sink()
91 :     st
92 :     options(op)
93 : maechler 676 }
94 : maechler 1737 }
95 : maechler 676 \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