rcpp_hdf5dataset_tcrossprod

OTHER

1 Description

Computes A \%*\% t(B) using the dedicated BigDataStatMeth block-wise transposed cross-product algorithm. When A and B refer to the same dataset, the symmetric optimisation is applied automatically.

2 Usage

rcpp_hdf5dataset_tcrossprod(ptr_a, ptr_b, paral = NULL, block_size = NULL, threads = NULL, compression = NULL, outgroup = NULL, outdataset = 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 when
`outgroup`	Character or NULL. Output group in the HDF5 file. Default .
`outdataset`	Character or NULL. Output dataset name. Default (single matrix) or (two matrices).

4 Value

Named list with and of the result.

---
title: "rcpp_hdf5dataset_tcrossprod"
subtitle: "rcpp_hdf5dataset_tcrossprod"
---

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

## Description

Computes `A \%*\% t(B)` using the dedicated BigDataStatMeth
block-wise transposed cross-product algorithm. When A and B refer to the
same dataset, the symmetric optimisation is applied automatically.

## Usage

```r
rcpp_hdf5dataset_tcrossprod(ptr_a, ptr_b, paral = NULL, block_size = NULL, threads = NULL, compression = NULL, outgroup = NULL, outdataset = 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 when \code{paral = TRUE} |
| `outgroup` | Character or NULL. Output group in the HDF5 file.   Default \code{"OUTPUT"}. |
| `outdataset` | Character or NULL. Output dataset name.   Default \code{"tCrossProd_A"} (single matrix) or   \code{"tCrossProd_A_x_B"} (two matrices).  |
:::

## Value

::: {.return-value}
Named list with \code{filename} and \code{path} of the result.

:::