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