rcpp_hdf5dataset_crossprod: Cross product for HDF5 datasets (R6 wrapper)

View source: R/RcppExports.R

rcpp_hdf5dataset_crossprodR Documentation

Cross product for HDF5 datasets (R6 wrapper)

Description

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

Usage

rcpp_hdf5dataset_crossprod(
  ptr_a,
  ptr_b,
  paral = NULL,
  block_size = NULL,
  threads = NULL,
  compression = NULL,
  outgroup = NULL,
  outdataset = NULL
)

Arguments

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 paral = TRUE

outgroup

Character or NULL. Output group in the HDF5 file. Default "OUTPUT".

outdataset

Character or NULL. Output dataset name. Default "CrossProd_A" (single matrix) or "CrossProd_A_x_B" (two matrices).

Value

Named list with filename and path of the result.


BigDataStatMeth documentation built on May 15, 2026, 1:07 a.m.