File: matrix.csc.hb-class.Rd

package info (click to toggle)
r-cran-sparsem 1.84-2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,648 kB
  • sloc: fortran: 3,998; ansic: 75; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 2,287 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
\name{matrix.csc.hb-class}
\title{Class "matrix.csc.hb" - Column Compressed Sparse Matrices stored in Harwell-Boeing Format}
\docType{class}
\alias{matrix.csc.hb-class}
\alias{show,matrix.csc.hb-method}
\alias{show,matrix.ssc.hb-method}
\description{
  A class consisting of the coefficient matrix and the right-hand-side of a
  linear system of equations, initial guess of the solution and the exact
  solutions if they exist stored in external files using the
  Harwell-Boeing format.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("matrix.csc.hb", ...)}.
}
\section{Slots}{
  \describe{
    \item{\code{ra}:}{Object of class \code{numeric}, ra component of the csc or ssc format of the coefficient matrix, X.}
    \item{\code{ja}:}{Object of class \code{integer}, ja component of the csc or ssc format of the coefficient matrix, X.}
    \item{\code{ia}:}{Object of class \code{numeric}, ia component of the csc or ssc format of the coefficient matrix, X.}
    \item{\code{rhs.ra}:}{Object of class \code{numeric}, ra component of the right-hand-side, y, if stored in csc or
        ssc format; right-hand-side stored in dense vector or matrix otherwise.}
    \item{\code{guess}:}{Object of class \code{numeric} or \code{NULL} vector of the initial guess of the solutions if they exist;
        a null vector otherwise.}
    \item{\code{xexact}:}{Object of class \code{numeric or NULL} vector of the exact solutions, b, if they exist; a null vector otherwise.}
    \item{\code{dimension}:}{Object of class \code{integer}, dimenson of the coefficient matrix, X.}
    \item{\code{rhs.dim}:}{Object of class \code{integer}, dimenson of the right-hand-side, y.}
    \item{\code{rhs.mode}:}{Object of class \code{character or NULL} storage mode of the right-hand-side; can be full storage or
        same format as the coefficient matrix.}
  }
}

\section{Methods}{
  \describe{
    \item{model.matrix}{\code{signature(object = "matrix.csc.hb")}: ... }
    \item{show}{\code{signature(object = "matrix.csc.hb")}:
      \code{\link{show}()} the object, notably also when auto-printing.}
  }
}
\seealso{\code{\link{model.matrix}}, \code{\link{model.response}}, 
  \code{\link{read.matrix.hb}},  \code{\link{matrix.ssc.hb-class}}}
\keyword{classes}