rcpp_hdf5dataset_subtract

OTHER

1 Description

Computes A - B element-wise for two HDF5 datasets referenced by external pointers, using a block-wise algorithm.

2 Usage

rcpp_hdf5dataset_subtract(ptr_a, ptr_b, paral = NULL, block_size = NULL, threads = NULL, compression = NULL)

3 Arguments

Parameter	Description
`ptr_a`	External pointer (SEXP) for matrix A
`ptr_b`	External pointer (SEXP) for matrix B
`paral`	Logical or NULL; enable OpenMP parallelisation
`block_size`	Integer or NULL; block size (NULL = auto)
`threads`	Integer or NULL; thread count

4 Value

Named list with and of the result. The result is stored in group with dataset name (resp. , , ) where A and B are the input dataset names.

---
title: "rcpp_hdf5dataset_subtract"
subtitle: "rcpp_hdf5dataset_subtract"
---

<span class="category-badge other">OTHER</span>

## Description

Computes `A - B` element-wise for two HDF5 datasets referenced by
external pointers, using a block-wise algorithm.

## Usage

```r
rcpp_hdf5dataset_subtract(ptr_a, ptr_b, paral = NULL, block_size = NULL, threads = NULL, compression = NULL)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `ptr_a` | External pointer (SEXP) for matrix A |
| `ptr_b` | External pointer (SEXP) for matrix B |
| `paral` | Logical or NULL; enable OpenMP parallelisation |
| `block_size` | Integer or NULL; block size (NULL = auto) |
| `threads` | Integer or NULL; thread count  |
:::

## Value

::: {.return-value}
Named list with \code{filename} and \code{path} of the result.
  The result is stored in group \code{"OUTPUT"} with dataset name
  \code{"A_plus_B"} (resp. \code{"A_minus_B"}, \code{"A_times_B"},
  \code{"A_div_B"}) where A and B are the input dataset names.

:::