# SCM Repository

[matrix] View of /pkg/man/dgTMatrix-class.Rd
 [matrix] / pkg / man / dgTMatrix-class.Rd

# View of /pkg/man/dgTMatrix-class.Rd

Thu Feb 3 14:24:03 2005 UTC (14 years, 7 months ago) by bates
File size: 2579 byte(s)
Getting package to pass CMD check
\name{dgTMatrix-class}
\docType{class}
\alias{dgTMatrix-class}
\alias{+,dgTMatrix,dgTMatrix-method}
\alias{coerce,dgTMatrix,dgeMatrix-method}
\alias{coerce,dgTMatrix,matrix-method}
\alias{coerce,dgTMatrix,dgCMatrix-method}
\alias{coerce,dgTMatrix,dsCMatrix-method}
\alias{image,dgTMatrix-method}
\alias{t,dgTMatrix-method}
\alias{crossprod,dgTMatrix,missing-method}
\alias{crossprod,dgTMatrix,matrix-method}
\alias{crossprod,dgTMatrix,numeric-method}
\title{Sparse matrices in triplet form}
\description{The \code{"dgTMatrix"} class is the class of sparse
matrices stored as (possibly redundant) triplets.}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("dgTMatrix", ...)}.
}
\section{Slots}{
\describe{
\item{\code{i}:}{Object of class \code{"integer"} - the row indices
of non-zero entries.}
\item{\code{j}:}{Object of class \code{"integer"} - the column
indices of non-zero entries.  Must be the same length as slot \code{i}.}
\item{\code{x}:}{Object of class \code{"numeric"} - the (non-zero)
entry at position \code{(i,j)}.  Must be the same length as slot
\code{i}. If an index pair occurs more than once the corresponding
values of slot \code{x} are added to form the element of the matrix.}
\item{\code{Dim}:}{Object of class \code{"integer"} of length 2 -
the dimensions of the matrix.}
}
}
\section{Methods}{
\describe{
\item{+}{\code{signature(e1 = "dgTMatrix", e2 = "dgTMatrix")}}
\item{coerce}{\code{signature(from = "dgTMatrix", to = "dgCMatrix")}}
\item{coerce}{\code{signature(from = "dgTMatrix", to = "dgeMatrix")}}
\item{coerce}{\code{signature(from = "dgTMatrix", to = "matrix")}}
\item{coerce}{\code{signature(from = "dgTMatrix", to = "dsCMatrix")}}
\item{crossprod}{\code{signature(x = "dgTMatrix", y = "missing")}
returns \code{t(x) \%*\% x} as an \code{dsCMatrix} object.}
\item{crossprod}{\code{signature(x = "dgTMatrix", y = "matrix")}: ... }
\item{crossprod}{\code{signature(x = "dgTMatrix", y = "numeric")}: ... }
\item{image}{\code{signature(x = "dgTMatrix")}: plots an image of
\item{t}{\code{signature(x = "dgTMatrix")}: returns the transpose of
\code{x}}
}
}
%\references{}
%\author{}
\note{Triplet matrices are a convenient form in which to construct sparse
matrices after which they can be coerced to \code{dgCMatrix} objects.}
\seealso{
}
%\examples{}
\keyword{classes}
\keyword{algebra}