pdCompSymm-class {lme4} | R Documentation

## Class "pdCompSymm"

### Description

A class of parameterized positive-definite symmetric matrices that have compound symmetry. That is, the diagonal entries are constant and the off-diagonal entries are constant.

### Objects from the Class

Objects can be created by calls of the form `new("pdCompSymm", ...)` or by calls to the constructor `pdCompSymm(...)`

### Slots

`param`:
  Object of class `"numeric"` - a parameter vector of length 2
`ncol`:
  Object of class `"integer"` - the number of columns (and rows) in the matrix.
`form`:
  Object of class `"formula", from class "pdMat"` - an optional formula relating the object to a model matrix.
`Names`:
  Object of class `"character", from class "pdMat"` - dimnames for the matrix

### Extends

Class `"pdMat"`, directly.

### Methods

coef
  `signature(x = "pdCompSymm")`: get the parameter vector
coef<-
  `signature(object = "pdCompSymm", value = "numeric")`: set the parameter vector
coef<-
  `signature(object = "pdCompSymm", value = "matrix")`: set the parameter vector from a model matrix
coerce
  `signature(from = "pdCompSymm", to = "matrix")`: get the positive-definite symmetric matrix represented by the object.
corMatrix
  `signature(object = "pdCompSymm")`: get the matrix represented by the object as a correlation matrix (with standard deviations)
dim
  `signature(x = "pdCompSymm")`: get the dimensions of the matrix represented by the object.
isInitialized
  `signature(object = "pdCompSymm")`: check if the object has been initialized.
logDet
  `signature(object = "pdCompSymm", covariate = "missing")`: get the logarithm of the determinant of the matrix
pdFactor
  `signature(object = "pdCompSymm")`: get a square root factor of the matrix represented by the object.
pdMatrix
  `signature(object = "pdCompSymm", factor = "logical")`: get the positive-definite symmetric matrix represented by the object.
summary
  `signature(object = "pdCompSymm")`:

### Author(s)

Douglas Bates bates@stat.wisc.edu and Saikat DebRoy saikat@stat.wisc.edu

### See Also

### Examples

[Package Contents]