collapse_matrix {mrgsolve}

Collapse the matrices of a matlist object

Description

This function is called by collapse_omega() and collapse_sigma() to convert multiple matrix blocks into a single matrix block. This "collapsing" of the matrix list is irreversible.

Usage

collapse_matrix(x, range = NULL, name = NULL)

Arguments

x

an object that inherits from matlist; this object is most frequently extracted from a model object using omat() or smat() for OMEGA and SIGMA, respectively

range

numeric vector of length 2 specifying the range of matrices to collapse in case there are more than 2. The second element may be NA to indicate the length of the list of matrices.

name

a new name for the collapsed matrix; note that this is the matrix name, not the labels which alias ETA(n) or EPS(n); specifying a name will only alter how this matrix is potentially updated in the future

Value

An update matlist object (either omegalist or sigmalist).

See Also

collapse_omega(), collapse_sigma(), omat(), smat()

Examples

omega <- omat(list(dmat(1, 2), dmat(3, 4, 5)))
omega
collapse_matrix(omega)