multiply_sparse

MATRIX_UTILS

1 Description

Generic function for block-wise sparse matrix multiplication. The method for HDF5Matrix computes x \%*\% y using the BigDataStatMeth sparse multiplication algorithm, which skips all-zero blocks and is more efficient when one or both matrices are highly sparse.

2 Usage

multiply_sparse(x, y, ...)

3 Arguments

Parameter	Description
`x`	An .
`y`	An . Must be in the same HDF5 file as .

4 Value

A new containing the product.

5 Examples

\donttest{
fn <- tempfile(fileext = ".h5")
X  <- hdf5_create_matrix(fn, "data/A", data = matrix(rnorm(100), 10, 10))
X  <- hdf5_create_matrix(fn, "data/B", data = matrix(rnorm(100), 10, 10))


A <- hdf5_matrix(fn, "data/A")
B <- hdf5_matrix(fn, "data/B")
C <- multiply_sparse(A, B)

hdf5_close_all()
unlink(fn)

}

6 See Also

multiply_sparse.HDF5Matrix

---
title: "multiply_sparse"
subtitle: "multiply_sparse"
---

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

## Description

Generic function for block-wise sparse matrix multiplication.
The method for `HDF5Matrix` computes `x \%*\% y` using the
BigDataStatMeth sparse multiplication algorithm, which skips all-zero
blocks and is more efficient when one or both matrices are highly sparse.

## Usage

```r
multiply_sparse(x, y, ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix}. |
| `y` | An \code{HDF5Matrix}. Must be in the same HDF5 file as \code{x}. |
:::

## Value

::: {.return-value}
A new \code{HDF5Matrix} containing the product.

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

\donttest{
fn <- tempfile(fileext = ".h5")
X  <- hdf5_create_matrix(fn, "data/A", data = matrix(rnorm(100), 10, 10))
X  <- hdf5_create_matrix(fn, "data/B", data = matrix(rnorm(100), 10, 10))


A <- hdf5_matrix(fn, "data/A")
B <- hdf5_matrix(fn, "data/B")
C <- multiply_sparse(A, B)

hdf5_close_all()
unlink(fn)

}

```
## See Also

::: {.see-also}
[multiply_sparse.HDF5Matrix](multiply_sparse.HDF5Matrix.html)

:::