# SCM Repository

[matrix] Diff of /pkg/man/CsparseMatrix-class.Rd
 [matrix] / pkg / man / CsparseMatrix-class.Rd

# Diff of /pkg/man/CsparseMatrix-class.Rd

revision 2311, Tue Jan 6 14:56:04 2009 UTC revision 2312, Sat Jan 10 14:01:26 2009 UTC
# Line 34  Line 34
34  \alias{Logic,CsparseMatrix,CsparseMatrix-method}  \alias{Logic,CsparseMatrix,CsparseMatrix-method}
35  \alias{Math,CsparseMatrix-method}  \alias{Math,CsparseMatrix-method}
36  %  %
37    \alias{.validateCsparse}
38    %
39  \title{Class "CsparseMatrix" of Sparse Matrices in Column-compressed Form}  \title{Class "CsparseMatrix" of Sparse Matrices in Column-compressed Form}
40  \description{The \code{"CsparseMatrix"} class is the virtual class of  \description{The \code{"CsparseMatrix"} class is the virtual class of
41    all sparse matrices coded in sorted compressed column-oriented form.    all sparse matrices coded in sorted compressed column-oriented form.
# Line 51  Line 53
53        for each column, to the initial (zero-based) index of elements in        for each column, to the initial (zero-based) index of elements in
54        the column.  \code{.@p} is of length \code{ncol(.) + 1}, with        the column.  \code{.@p} is of length \code{ncol(.) + 1}, with
55        \code{p[1] == 0} and \code{p[length(p)] == nnzero}, such that in        \code{p[1] == 0} and \code{p[length(p)] == nnzero}, such that in
56        fact, \code{diff(.@p + 1)} are the number of non-zero elements for        fact, \code{diff(.@p)} are the number of non-zero elements for
57        each column.}        each column.}
58      \item{\code{factors}, \code{Dim}, \code{Dimnames}:}{inherited from      \item{\code{factors}, \code{Dim}, \code{Dimnames}:}{inherited from
59        the superclass, see the \code{\linkS4class{sparseMatrix}} class.}        the superclass, see the \code{\linkS4class{sparseMatrix}} class.}
# Line 103  Line 105
105  }  }
106  \note{  \note{
107    All classes extending \code{CsparseMatrix} have a common validity    All classes extending \code{CsparseMatrix} have a common validity
108    (see \code{\link{validObject}}) check function.  The function    (see \code{\link{validObject}}) check function.  That function
109    additionally checks and if necessary \emph{sorts} the entries in    additionally checks the \code{i} slot for each column to contain
110    each row into increasing row numbers.  This allows to use    increasing row numbers. \cr
111    \code{new()} calls with somewhat permuted \code{i} and \code{x}    In earlier versions of \pkg{Matrix} (\code{<= 0.999375-16}),
112    slots, as \code{\link{new}(...)} (\emph{with} slot arguments)    \code{\link{validObject}} automatically re-sorted the entries when
113    automatically checks the validity, see the example.    necessary, and hence \code{new()} calls with somewhat permuted
114      \code{i} and \code{x} slots worked, as \code{\link{new}(...)}
115      (\emph{with} slot arguments) automatically checks the validity.
116
117      Now, you have to use \code{\link{sparseMatrix}} to achieve the same
118      functionality or know how to use \code{.validateCsparse()} to do so.
119  }  }
120  \seealso{  \seealso{