diag

MATRIX_UTILS

1 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)).

2 Usage

diag(x, ...)

3 Arguments

Parameter	Description
`x`	An or any object accepted by .
`nrow`	Passed to for non-HDF5Matrix objects.
`ncol`	Passed to for non-HDF5Matrix objects.
`names`	Passed to for non-HDF5Matrix objects.

4 Value

For : numeric vector of diagonal elements. For plain R objects: result of .

5 See Also

\link[base]{diag}

---
title: "diag"
subtitle: "diag"
---

<span class="category-badge matrix_utils">MATRIX_UTILS</span>

## 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

```r
diag(x, ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} or any object accepted by \code{base::diag()}. |
| `nrow` | Passed to \code{base::diag()} for non-HDF5Matrix objects. |
| `ncol` | Passed to \code{base::diag()} for non-HDF5Matrix objects. |
| `names` | Passed to \code{base::diag()} for non-HDF5Matrix objects. |
:::

## Value

::: {.return-value}
For \code{HDF5Matrix}: numeric vector of diagonal elements.
  For plain R objects: result of \code{base::diag()}.

:::
## See Also

::: {.see-also}
`\link[base]{diag`}

:::