tatami_mult::Options Struct Reference

Options for multiply(). More...

#include <tatami_mult.hpp>

Public Attributes
int	num_threads = 1
bool	prefer_larger = true
bool	column_major_output = true

Detailed Description

Options for multiply().

Member Data Documentation

column_major_output

bool tatami_mult::Options::column_major_output = true

Whether to save the product as a column-major matrix in output, for the multiply() overload that accepts two tatami::Matrix objects. If false, the product is instead saved as a row-major matrix.

num_threads

int tatami_mult::Options::num_threads = 1

Number of threads to use, for parallelization via tatami::parallelize().

prefer_larger

bool tatami_mult::Options::prefer_larger = true

Whether to iterate over the preferred dimension of the larger matrix, for the multiply() overload that accepts two tatami::Matrix objects. This organizes the multiplication so that it only passes over the larger matrix once, while passing through the other matrix multiple times. If false, the multiplication is performed with the supplied left and right matrices.

---

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

• /github/workspace/include/tatami_mult/tatami_mult.hpp