Learn R Programming

BigDataStatMeth (version 2.0.3)

diag: Extract or construct a diagonal for HDF5Matrix

Description

Overrides base::diag() to dispatch on HDF5Matrix objects. For plain R matrices/vectors the call is forwarded to base::diag().

When x is an HDF5Matrix, extracts the diagonal as an in-memory numeric vector (length = min(nrow, ncol)).

Usage

diag(x, ...)

# S3 method for default diag(x, nrow, ncol, names = TRUE, ...)

# S3 method for HDF5Matrix diag(x, ...)

Value

For HDF5Matrix: numeric vector of diagonal elements. For plain R objects: result of base::diag().

Arguments

x

An HDF5Matrix or any object accepted by base::diag().

...

Ignored.

nrow

Passed to base::diag() for non-HDF5Matrix objects.

ncol

Passed to base::diag() for non-HDF5Matrix objects.

names

Passed to base::diag() for non-HDF5Matrix objects.

See Also