svd.HDF5Matrix

svd.HDF5Matrix

DECOMPOSITIONS

1 Usage

svd.HDF5Matrix(...)

2 Arguments

Parameter	Description
`x`	An object.
`nu`	Number of left singular vectors to compute (default = ).
`nv`	Number of right singular vectors to compute (default = ).
`center`	Logical. Center columns before decomposition (default ).
`scale`	Logical. Scale columns before decomposition (default ).
`k`	Number of local SVDs per incremental level (default 2).
`q`	Number of incremental levels (default 1).
`method`	Computation method: (default), , or .
`rankthreshold`	Numeric in . Rank approximation threshold (default 0).
`overwrite`	Logical. Overwrite existing SVD results (default ).
`threads`	Integer. OpenMP threads ( = auto-detect).

3 Value

Named list with:

4 Examples

\donttest{
tmp <- tempfile(fileext = ".h5")
X   <- hdf5_create_matrix(tmp, "data/M", data = matrix(rnorm(500), 50, 10))
res <- svd(X)
length(res$d)   # 10  (min(50,10))
dim(res$u)      # 50 x 10
dim(res$v)      # 10 x 10
X$close()
res$u$close(); res$v$close()
unlink(tmp)
}

---
title: "svd.HDF5Matrix"
subtitle: "svd.HDF5Matrix"
---

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

## Usage

```r
svd.HDF5Matrix(...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} object. |
| `nu` | Number of left  singular vectors to compute (default = \code{min(dim(x))}). |
| `nv` | Number of right singular vectors to compute (default = \code{min(dim(x))}). |
| `center` | Logical.  Center columns before decomposition (default \code{TRUE}). |
| `scale` | Logical.  Scale  columns before decomposition (default \code{TRUE}). |
| `k` | Number of local SVDs per incremental level (default 2). |
| `q` | Number of incremental levels (default 1). |
| `method` | Computation method: \code{"auto"} (default), \code{"blocks"},   or \code{"full"}. |
| `rankthreshold` | Numeric in \code{[0, 0.1]}.  Rank approximation   threshold (default 0). |
| `overwrite` | Logical.  Overwrite existing SVD results (default \code{FALSE}). |
| `threads` | Integer.  OpenMP threads (\code{-1} = auto-detect). |
:::

## Value

::: {.return-value}
Named list with:
  \describe{
    \item{\code{d}}{Numeric vector of non-negative singular values, decreasing.}
    \item{\code{u}}{HDF5Matrix of left  singular vectors, \code{nrow(x) x nu}.}
    \item{\code{v}}{HDF5Matrix of right singular vectors, \code{ncol(x) x nv}.}
  }

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

\donttest{
tmp <- tempfile(fileext = ".h5")
X   <- hdf5_create_matrix(tmp, "data/M", data = matrix(rnorm(500), 50, 10))
res <- svd(X)
length(res$d)   # 10  (min(50,10))
dim(res$u)      # 50 x 10
dim(res$v)      # 10 x 10
X$close()
res$u$close(); res$v$close()
unlink(tmp)
}

```