tatami_mtx::Options Struct Reference

Options for load_matrix() and friends. More...

#include <load_matrix.hpp>

Public Attributes
bool	row = true
size_t	buffer_size = 65536
bool	parallel = false
int	compression = 3

Detailed Description

Options for load_matrix() and friends.

Member Data Documentation

row

bool tatami_mtx::Options::row = true

Whether to produce a dense row-major or compressed sparse row matrix. If false, column-based matrices are returned instead.

buffer_size

size_t tatami_mtx::Options::buffer_size = 65536

Size of the buffer (in bytes) to use when reading the file contents. This buffer size is also used for Gzip/Zlib decompression. Ignored for load_matrix_from_text_buffer().

parallel

bool tatami_mtx::Options::parallel = false

Whether to parallelize the reading and parsing. If true, chunks of the file are read (and decompressed) in one thread while the contents are parsed in another thread.

compression

int tatami_mtx::Options::compression = 3

Compression of a Zlib-compressed buffer in load_matrix_from_zlib_buffer(). The default of 3 will auto-detect the compression method, see byteme::ZlibBufferReader for details.

---

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

• tatami_mtx/load_matrix.hpp