R: Examples for 'Matrix::symmetricMatrix-class'

### ** Examples

## An example about the symmetric Dimnames:
sy <- sparseMatrix(i= c(2,4,3:5), j= c(4,7:5,5), x = 1:5, dims = c(7,7),
                   symmetric=TRUE, dimnames = list(NULL, letters[1:7]))
sy # shows symmetrical dimnames

7 x 7 sparse Matrix of class "dsCMatrix"
  a b c d e f g
a . . . . . . .
b . . . 1 . . .
c . . . . . 3 .
d . 1 . . 4 . 2
e . . . 4 5 . .
f . . 3 . . . .
g . . . 2 . . .

sy@Dimnames  # internally only one part is stored

[[1]]
NULL

[[2]]
[1] "a" "b" "c" "d" "e" "f" "g"

dimnames(sy) # both parts - as sy *is* symmetrical

[[1]]
[1] "a" "b" "c" "d" "e" "f" "g"

[[2]]
[1] "a" "b" "c" "d" "e" "f" "g"

## Don't show: 
local({ nm <- letters[1:7]
  stopifnot(identical(dimnames(sy), list(  nm, nm)),
            identical(sy@Dimnames , list(NULL, nm)))
})
## End(Don't show)
showClass("symmetricMatrix")

Virtual Class "symmetricMatrix" [package "Matrix"]

Slots:
                                              
Name:       uplo   factors       Dim  Dimnames
Class: character      list   integer      list

Extends: 
Class "compMatrix", directly
Class "Matrix", by class "compMatrix", distance 2
Class "mMatrix", by class "Matrix", distance 3
Class "replValueSp", by class "Matrix", distance 3

Known Subclasses: 
Class "nsyMatrix", directly
Class "nspMatrix", directly
Class "lsyMatrix", directly
Class "lspMatrix", directly
Class "dsyMatrix", directly
Class "dspMatrix", directly
Class "nsCMatrix", directly
Class "nsRMatrix", directly
Class "nsTMatrix", directly
Class "lsCMatrix", directly
Class "lsRMatrix", directly
Class "lsTMatrix", directly
Class "dsCMatrix", directly
Class "dsRMatrix", directly
Class "dsTMatrix", directly
Class "dpoMatrix", by class "dsyMatrix", distance 2
Class "dppMatrix", by class "dspMatrix", distance 2
Class "corMatrix", by class "dsyMatrix", distance 3

## The names of direct subclasses:
scl <- getClass("symmetricMatrix")@subclasses
directly <- sapply(lapply(scl, slot, "by"), length) == 0
names(scl)[directly]

 [1] "nsyMatrix" "nspMatrix" "lsyMatrix" "lspMatrix" "dsyMatrix" "dspMatrix"
 [7] "nsCMatrix" "nsRMatrix" "nsTMatrix" "lsCMatrix" "lsRMatrix" "lsTMatrix"
[13] "dsCMatrix" "dsRMatrix" "dsTMatrix"

## Methods -- applicaple to all subclasses above:
showMethods(classes = "symmetricMatrix")

Function: chol (package base)
x="symmetricMatrix"

Function: coerce (package methods)
from="diagonalMatrix", to="symmetricMatrix"
from="dsCMatrix", to="symmetricMatrix"
from="dsTMatrix", to="symmetricMatrix"
from="matrix", to="symmetricMatrix"
from="Matrix", to="symmetricMatrix"

Function: crossprod (package base)
x="symmetricMatrix", y="ANY"
x="symmetricMatrix", y="Matrix"
x="symmetricMatrix", y="missing"

Function: dimnames (package base)
x="symmetricMatrix"

Function: isSymmetric (package base)
object="symmetricMatrix"

Function: isTriangular (package Matrix)
object="symmetricMatrix"

Function: Schur (package Matrix)
x="symmetricMatrix", vectors="logical"

Function: tcrossprod (package base)
x="ANY", y="symmetricMatrix"
x="Matrix", y="symmetricMatrix"

Examples for 'Matrix::symmetricMatrix-class'

Virtual Class of Symmetric Matrices in Package Matrix