tatami_python::UnknownMatrixOptions Struct Reference

Options for data extraction from an UnknownMatrix. More...

#include <UnknownMatrix.hpp>

Public Attributes
std::size_t	maximum_cache_size = sanisizer::cap<std::size_t>(100000000)
bool	require_minimum_cache = true

Detailed Description

Options for data extraction from an UnknownMatrix.

Member Data Documentation

maximum_cache_size

std::size_t tatami_python::UnknownMatrixOptions::maximum_cache_size = sanisizer::cap<std::size_t>(100000000)

Size of the cache, in bytes.

require_minimum_cache

bool tatami_python::UnknownMatrixOptions::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:

• /github/workspace/include/tatami_python/UnknownMatrix.hpp