diag_scale

MATRIX_UTILS

1 Description

Applies a scalar arithmetic operation to the diagonal elements of an HDF5Matrix. Off-diagonal elements are not modified. Delegates to bdDiag_scalar_hdf5().

2 Usage

diag_scale(x, scalar, op = "multiply", ...)

3 Arguments

Parameter	Description
`x`	An .
`scalar`	Numeric scalar.
`op`	Operation: , , (default), or .
`outgroup`	Character or . HDF5 group where the result is stored. Default .
`outdataset`	Character or . Dataset name for the result.
`overwrite`	Logical. If , overwrite the existing result dataset. Default .

4 Value

A new .

5 Examples

\donttest{
tmp <- tempfile(fileext = ".h5")
M   <- hdf5_create_matrix(tmp, "data/M", data = diag(5))
R   <- diag_scale(M, scalar = 3, op = "multiply")
hdf5_close_all()
unlink(tmp)
}

6 See Also

diag_op

---
title: "diag_scale"
subtitle: "diag_scale"
---

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

## Description

Applies a scalar arithmetic operation to the diagonal elements of an
`HDF5Matrix`. Off-diagonal elements are not modified.
Delegates to `bdDiag_scalar_hdf5()`.

## Usage

```r
diag_scale(x, scalar, op = "multiply", ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix}. |
| `scalar` | Numeric scalar. |
| `op` | Operation: \code{"add"}, \code{"subtract"},   \code{"multiply"} (default), or \code{"divide"}. |
| `outgroup` | Character or \code{NULL}. HDF5 group where the result is   stored. Default \code{"OUTPUT"}. |
| `outdataset` | Character or \code{NULL}. Dataset name for the result. |
| `overwrite` | Logical. If \code{TRUE}, overwrite the existing result   dataset. Default \code{FALSE}. |
:::

## Value

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

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

\donttest{
tmp <- tempfile(fileext = ".h5")
M   <- hdf5_create_matrix(tmp, "data/M", data = diag(5))
R   <- diag_scale(M, scalar = 3, op = "multiply")
hdf5_close_all()
unlink(tmp)
}

```
## See Also

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