tatami_hdf5::DenseMatrixOptions Struct Reference

Options for DenseMatrix extraction. More...

#include <DenseMatrix.hpp>

Public Attributes
size_t	maximum_cache_size = 100000000
bool	require_minimum_cache = true

Detailed Description

Options for DenseMatrix extraction.

Member Data Documentation

maximum_cache_size

size_t tatami_hdf5::DenseMatrixOptions::maximum_cache_size = 100000000

Size of the in-memory cache in bytes.

We cache all chunks required to read a row/column in tatami::MyopicDenseExtractor::fetch() and related methods. This allows us to re-use the cached chunks when adjacent rows/columns are requested, rather than re-reading them from disk.

Larger caches improve access speed at the cost of memory usage. Small values may be ignored if require_minimum_cache is true.

require_minimum_cache

bool tatami_hdf5::DenseMatrixOptions::require_minimum_cache = true

Whether to automatically enforce a minimum size for the cache, regardless of maximum_cache_size. This minimum is chosen to ensure that all chunks overlapping one row (or a slice/subset thereof) can be retained in memory, so that the same chunks are not repeatedly re-read from disk when iterating over consecutive rows/columns of the matrix.

---

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

• tatami_hdf5/DenseMatrix.hpp