Summarize a pdMat Object

DESCRIPTION:

Attributes structName and noCorrelation, with the values of the corresponding arguments to the method function, are appended to object and its class is changed to summary.pdMat.

USAGE:

summary(object, structName, noCorrelation) 

REQUIRED ARGUMENTS:

object
an object inheriting from class pdMat, representing a positive definite matrix.

OPTIONAL ARGUMENTS:

structName
an optional character string with a description of the pdMat class. Default depends on the method function: "Blocked" for pdBlocked, "Compound Symmetry" for pdCompSymm, "Diagonal" for pdDiag, "Multiple of an Identity" for pdIdent, "General Positive-Definite" for pdSymm, and data.class(object) for pdMat.
noCorrelation
an optional logical value indicating whether correlations are to be printed in print.summary.pdMat. Default depends on the method function: FALSE for pdDiag and pdIdent, and TRUE for all other classes.

VALUE:

an object similar to object, with additional attributes structName and noCorrelation, inheriting from class summary.pdMat .

SEE ALSO:

,

EXAMPLES:

summary(pdSymm(diag(4)))