tatami_mult::MultiplyWithMatrixOptions Struct Reference

Options for multiply_with_matrix(). More...

#include <tatami_mult.hpp>

Public Attributes
MultiplyWithDenseMatrixOptions	dense_matrix
MultiplyWithSparseMatrixOptions	sparse_matrix
bool	larger_left = true

Detailed Description

Options for multiply_with_matrix().

Member Data Documentation

dense_matrix

MultiplyWithDenseMatrixOptions tatami_mult::MultiplyWithMatrixOptions::dense_matrix

Options to pass to multiply_row_with_dense_matrix(), if right is a dense matrix that prefers row access.

larger_left

bool tatami_mult::MultiplyWithMatrixOptions::larger_left = true

Whether to set the larger matrix as the LHS matrix in the delegated functions. If right is larger, we transpose and swap left and right prior to calling the delegated functions. This ensures that we only pass over the larger matrix once while potentially passing through the smaller matrix multiple times. The result does not change though the delegated function will now be chosen based on the transposed left.

If this is false (or right is already smaller), the multiplication is performed exactly with the supplied left and right matrices.

sparse_matrix

MultiplyWithSparseMatrixOptions tatami_mult::MultiplyWithMatrixOptions::sparse_matrix

Options to pass to multiply_row_with_sparse_matrix(), if right is a sparse matrix that prefers row access.

---

The documentation for this struct was generated from the following file:

• tatami_mult/tatami_mult.hpp