pseudoinverse

DECOMPOSITIONS

1 Description

Generic function for computing the Moore-Penrose pseudoinverse. The HDF5Matrix method computes the pseudoinverse entirely on disk using block-wise SVD; the full matrix is never loaded into RAM.

Delegates to bdpseudoinv_hdf5(). Result stored in the same HDF5 file under OUTPUT/<dataset>_pinv by default.

2 Usage

pseudoinverse(x, ...)

3 Arguments

Parameter	Description
`x`	An object. For , the dataset stored on disk.

4 Value

For : a new containing the pseudoinverse.

5 Examples

\donttest{
tmp <- tempfile(fileext = ".h5")
m   <- matrix(c(1,2,3,4,5,6), 3, 2)
X   <- hdf5_create_matrix(tmp, "data/A", data = m)
P   <- pseudoinverse(X)
dim(P)   # 2 x 3
close(X); close(P)
unlink(tmp)
}

6 See Also

solve.HDF5Matrix, svd.HDF5Matrix

---
title: "pseudoinverse"
subtitle: "pseudoinverse"
---

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

## Description

Generic function for computing the Moore-Penrose pseudoinverse.
The `HDF5Matrix` method computes the pseudoinverse entirely on
disk using block-wise SVD; the full matrix is never loaded into RAM.

Delegates to `bdpseudoinv_hdf5()`. Result stored in the same
HDF5 file under `OUTPUT/<dataset>_pinv` by default.

## Usage

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

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An object. For \code{HDF5Matrix}, the dataset stored on disk. |
:::

## Value

::: {.return-value}
For \code{HDF5Matrix}: a new \code{HDF5Matrix} containing the
  pseudoinverse.

:::
## Examples
```{r}
#| eval: false
#| warning: false

\donttest{
tmp <- tempfile(fileext = ".h5")
m   <- matrix(c(1,2,3,4,5,6), 3, 2)
X   <- hdf5_create_matrix(tmp, "data/A", data = m)
P   <- pseudoinverse(X)
dim(P)   # 2 x 3
close(X); close(P)
unlink(tmp)
}

```
## See Also

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