Virtual Class "packedMatrix" of Packed Dense Matrices

Class "packedMatrix" is the virtual class of dense symmetric or triangular matrices in "packed" format, storing only the choose(n+1,2) == n*(n+1)/2 elements of the upper or lower triangle of an n-by-n matrix. It is used to define common methods for efficient subsetting, transposing, etc. of its proper subclasses: currently "[dln]spMatrix" (packed symmetric), "[dln]tpMatrix" (packed triangular), and subclasses of these, such as "dppMatrix".

Slots

uplo:

"character"; either "U", for upper triangular, and "L", for lower.

Dim, Dimnames:

as all Matrix objects.

Extends

Class "denseMatrix", directly. Class "Matrix", by class "denseMatrix", distance 2.

Methods

pack

signature(x = "packedMatrix"): ...

unpack

signature(x = "packedMatrix"): ...

isSymmetric

signature(object = "packedMatrix"): ...

isTriangular

signature(object = "packedMatrix"): ...

isDiagonal

signature(object = "packedMatrix"): ...

t

signature(x = "packedMatrix"): ...

diag

signature(x = "packedMatrix"): ...

diag<-

signature(x = "packedMatrix"): ...

Author

Mikael Jagan

See also

pack and unpack; its virtual "complement" "unpackedMatrix"; its proper subclasses "dspMatrix", "ltpMatrix", etc.

Examples

showClass("packedMatrix")
#> Virtual Class "packedMatrix" [package "Matrix"]
#> 
#> Slots:
#>                                     
#> Name:       uplo       Dim  Dimnames
#> Class: character   integer      list
#> 
#> Extends: 
#> Class "denseMatrix", directly
#> Class "Matrix", by class "denseMatrix", distance 2
#> 
#> Known Subclasses: 
#> Class "nspMatrix", directly
#> Class "ntpMatrix", directly
#> Class "lspMatrix", directly
#> Class "ltpMatrix", directly
#> Class "dspMatrix", directly
#> Class "dtpMatrix", directly
#> Class "dppMatrix", by class "dspMatrix", distance 2
#> Class "copMatrix", by class "dspMatrix", distance 3
showMethods(classes = "packedMatrix")
#> Function: coerce (package methods)
#> from="Matrix", to="packedMatrix"
#> from="dtpMatrix", to="packedMatrix"
#> from="generalMatrix", to="packedMatrix"
#> from="lgeMatrix", to="packedMatrix"
#>     (inherited from: from="generalMatrix", to="packedMatrix")
#> from="lspMatrix", to="packedMatrix"
#> from="matrix", to="packedMatrix"
#> from="nsyMatrix", to="packedMatrix"
#>     (inherited from: from="Matrix", to="packedMatrix")
#> 
#> Function: cov2cor (package stats)
#> V="packedMatrix"
#> 
#> Function: pack (package Matrix)
#> x="packedMatrix"
#> 
#> Function: unpack (package Matrix)
#> x="packedMatrix"
#>