pdMat-class {Matrix} | R Documentation |
A virtual class of parameterized positive-definite
symmetric matrices. This class describes the slots and methods that
actual classes of positive-definite matrices are expected to
incorporate. Some classes that inherit from pdMat
have
additional slots and methods.
Objects of class pdMat
are not constructed directly; only
objects from classes that inherit from pdMat
are constructed.
form
:"formula"
, holds the
formula for the object Names
:"character"
holding the
names of the rows (and columns) of the positive-definite symmetric
matrix represented by the object.param
:"numeric"
- the parameter vector.Ncol
:"integer"
- the number of columns (and
rows) in the matrix.factor
:"matrix"
- a square-root factor of the
matrix.logDet
:"numeric"
- the logarithm of the
determinant of the factor.signature(from = "pdMat", to = "pdfactor")
:
extract a square-root factor of the matrix represented by the
object. This factor has a logDet
slot giving the
logarithm of its determinant. In the case of pdLogChol
these are both scalars and the logDet
attribute is the
logarithm of the absolute value of the factor.signature(object = "pdMat")
: Extract the
correlation matrix corresponding to the positive-definite matrix
represented by the object. This method is present for back
compatibility only. The preferred way of extracting the
correlation matrix is to coerce the object to the
"corrmatrix"
class.signature(x = "pdMat")
: the dimensions of the
positive-definite matrix represented by the object.signature(x = "pdMat")
: extract the formula signature(object = "pdMat")
:
TRUE
if the object has been initialized, otherwise FALSE
.signature(object = "pdMat", covariate =
"missing")
: the logarithm of the determinant of the factor of
the positive-definite matrix represented by the object.signature(x = "pdMat")
: extract a vector of
names, which are both the column names and the row names of the
positive-definite matrix represented by the object.signature(x = "pdMat")
: assign the names,signature(object = "pdMat")
: Extract the
square root factor of positive-definite symmetric matrix
represented by the object. This method is present for back
compatibility only. The preferred way of extracting the factor is
to coerce the object to the "pdfactor"
class.signature(object = "pdMat")
: Extract the
positive-definite symmetric matrix represented by the object.
This method is present for back compatibility only. The preferred
way of extracting the positive-definite symmetric matrix is to
coerce the object to the "pdmatrix"
class.signature(x = "pdMat")
: show the object.signature(a = "pdMat", b = "missing")
: Create an
object of the same class representing the inverse of the
positive-definite matrix.signature(object = "pdMat")
:
pdMat
objects are primarily used to represent the variance-covariance
matrix or the precision matrix of random-effects terms in
mixed-effects models. Frequently they are constructed from a formula
only in the call to the mixed-effects modelling function then assigned
a value as part of the initialization of the model.
pdCompSymm-class
, pdDiag-class
,
pdLogChol-class
, pdIdent-class