File: PosDefSymmMatrix-class.Rd

package info (click to toggle)
r-cran-distr 2.9.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,344 kB
  • sloc: ansic: 199; sh: 13; makefile: 2
file content (41 lines) | stat: -rw-r--r-- 1,496 bytes parent folder | download | duplicates (2)
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
\name{PosDefSymmMatrix-class}
\docType{class}
\alias{PosDefSymmMatrix-class}
\alias{PosSemDefSymmMatrix-class}

\title{Positive-[Semi-]definite, symmetric matrices}
\description{The class of positive-[semi-]definite, symmetric matrices.}
\section{Objects from the Class}{
  Objects can be created by calls of the form \code{new("PosSemDefSymmMatrix", ...)}
  resp. \code{new("PosDefSymmMatrix", ...)}.
  More frequently they are created via the generating functions
  \code{PosSemDefSymmMatrix} resp. \code{PosDefSymmMatrix}. 
}
\section{Slots}{
  \describe{
    \item{\code{.Data}}{Object of class \code{"matrix"}. 
      A numeric matrix with finite entries.}
  }
}
\section{Extends}{
[Class \code{"PosSemDefSymmMatrix"}, directly]
Class \code{"matrix"}, from data part.\cr
Class \code{"structure"}, by class \code{"matrix"}.\cr
Class \code{"array"}, by class \code{"matrix"}.\cr
Class \code{"vector"}, by class "matrix", with explicit coerce.\cr
Class \code{"vector"}, by class "matrix", with explicit coerce.
}
%\section{Methods}{}
%\references{}
\author{Matthias Kohl \email{Matthias.Kohl@stamats.de},
Peter Ruckdeschel \email{peter.ruckdeschel@uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{PosDefSymmMatrix}}, \code{\link[methods:StructureClasses]{matrix-class}}}
\examples{
new("PosDefSymmMatrix", diag(2))
}
\concept{positive-definite matrix}
\concept{positive-semi-definite matrix}
\concept{symmetric matrix}
\keyword{classes}
\keyword{array}