diagonalMatrix-class {Matrix}R Documentation

Class "diagonalMatrix" of Diagonal Matrices

Description

Class "diagonalMatrix" is the virtual class of all diagonal matrices.

Objects from the Class

A virtual Class: No objects may be created from it.

Slots

diag:
code{"character"} string, either "U" or "N", where "U" means ‘unit-diagonal’.
Dim:
matrix dimension, and
Dimnames:
the dimnames, a list, see the Matrix class description. Typically list(NULL,NULL) for diagonal matrices.

Extends

Class "denseMatrix", directly.

Methods

coerce
signature(from = "matrix", to = "diagonalMatrix"): ...
coerce
signature(from = "diagonalMatrix", to = "symmetricMatrix"): ...
coerce
signature(from = "diagonalMatrix", to = "triangularMatrix"): ...
coerce
signature(from = "diagonalMatrix", to = "matrix"): ...
coerce
signature(from = "Matrix", to = "diagonalMatrix"): ...
t
signature(x = "diagonalMatrix"): ...
%*%
signature(x = "dgeMatrix", y = "diagonalMatrix"): ...
%*%
signature(x = "matrix", y = "diagonalMatrix"): ...
%*%
signature(x = "diagonalMatrix", y = "matrix"): ...
%*%
signature(x = "diagonalMatrix", y = "dgeMatrix"): ...
solve
signature(a = "diagonalMatrix", b, ...): is trivially implemented, of course.

See Also

ddiMatrix and ldiMatrix are “actual” classes extending "diagonalMatrix".

Examples

I5 <- Diagonal(5)
D5 <- Diagonal(x = 10*(1:5))
## trivial (but explicitly defined) methods:
stopifnot(identical(crossprod(I5), I5),
          identical(tcrossprod(I5), I5),
          identical(crossprod(I5, D5), D5),
          identical(tcrossprod(D5, I5), D5),
          identical(solve(D5), solve(D5, I5)),
          all.equal(D5, solve(solve(D5)), tol = 1e-12)
          )
solve(D5)

[Package Matrix version 0.999375-4 Index]