tatami_chunked::CustomSparseChunkedMatrixOptions Struct Reference

Options for data extraction from a CustomSparseChunkedMatrix. More...

#include <CustomSparseChunkedMatrix.hpp>

Public Attributes
size_t	maximum_cache_size = 100000000
bool	require_minimum_cache = true

Detailed Description

Options for data extraction from a CustomSparseChunkedMatrix.

Member Data Documentation

maximum_cache_size

size_t tatami_chunked::CustomSparseChunkedMatrixOptions::maximum_cache_size = 100000000

Size of the in-memory cache in bytes. 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_chunked::CustomSparseChunkedMatrixOptions::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 a single slab can be retained in memory, so that the same chunks are not repeatedly re-read when iterating over consecutive rows/columns of the matrix.

---

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

• tatami_chunked/CustomSparseChunkedMatrix.hpp