eigen

DECOMPOSITIONS

1 Description

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

2 Usage

eigen(x, symmetric, ...)

3 Arguments

Parameter	Description
`x`	An or any R object accepted by .
`symmetric`	Logical. Whether to assume is symmetric. Passed to for plain R objects.
`only.values`	Ignored. Present for compatibility with .
`EISPACK`	Ignored. Present for compatibility with .

4 Value

For : a named list with elements (numeric vector), ( or ), , and . For other objects: the result of .

5 See Also

svd.HDF5Matrix, prcomp.HDF5Matrix

---
title: "eigen"
subtitle: "eigen"
---

<span class="category-badge decompositions">DECOMPOSITIONS</span>

## Description

Overrides `base::eigen()` to dispatch on `HDF5Matrix`
objects. For plain R matrices the call is forwarded to
`base::eigen()`.

## Usage

```r
eigen(x, symmetric, ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} or any R object accepted   by \code{base::eigen()}. |
| `symmetric` | Logical. Whether to assume \code{x} is symmetric.   Passed to \code{base::eigen()} for plain R objects. |
| `only.values` | Ignored. Present for compatibility with \code{base::eigen}. |
| `EISPACK` | Ignored. Present for compatibility with \code{base::eigen}. |
:::

## Value

::: {.return-value}
For \code{HDF5Matrix}: a named list with elements
  \code{values} (numeric vector), \code{vectors}
  (\code{HDF5Matrix} or \code{NULL}), \code{values_imag}, and
  \code{is_symmetric}.
  For other objects: the result of \code{base::eigen()}.

:::
## See Also

::: {.see-also}
[svd.HDF5Matrix](svd.HDF5Matrix.html), [prcomp.HDF5Matrix](prcomp.HDF5Matrix.html)
:::