mc_factors: Factors of multi-companion matrices

View source: R/class_MC.R

mc_factorsR Documentation

Factors of multi-companion matrices

Description

Gives the factors comprising the companion factorisation of a multi-companion matrix.

Usage

mc_factors(x, what = "mc")

Arguments

x

a multi-companion matrix, an object of class MultiCompanion.

what

format of the result, see below.

Details

If the factors are available in the object's pad in the requested format, they are returned without further processing. The factors may be available if they have been previously computed or if the matrix has been created from the factors.

If the factors are available, but not in the requested format, they are converted to it. Otherwise the factors are computed.

The factors are stored in the object's pad under the name "mC.factors" when what == "mc", and in "mC.factorsmat" otherwise.

Value

If what == "mc" the companion factors of x as a list of MultiCompanion objects.

Otherwise a matrix with i-th row representing the i-th factor.

As a side effect, the factors are stored in the object's pad, see ‘Details’.

Author(s)

Georgi N. Boshnakov

References

\insertRef

boshnakov2002mcmcompanion

Examples

m <- mCompanion(matrix(1:8, nrow = 2))
mc_factors(m)

mcompanion documentation built on Sept. 22, 2023, 5:12 p.m.