Parameters for write_compressed_sparse_matrix(). More...

#include <write_compressed_sparse_matrix.hpp>

Public Attributes
std::string	data_name

std::string	index_name

std::string	ptr_name

WriteStorageLayout	columnar = WriteStorageLayout::AUTOMATIC

WriteStorageType	data_type = WriteStorageType::AUTOMATIC

bool	force_integer = false

WriteStorageType	index_type = WriteStorageType::AUTOMATIC

int	deflate_level = 6

hsize_t	chunk_size = sanisizer::cap<hsize_t>(100000)

int	num_threads = 1

Detailed Description

Parameters for write_compressed_sparse_matrix().

Member Data Documentation

◆ data_name

std::string tatami_hdf5::WriteCompressedSparseMatrixOptions::data_name

Name of the dataset in which to store the data values for non-zero elements. Defaults to "data".

◆ index_name

std::string tatami_hdf5::WriteCompressedSparseMatrixOptions::index_name

Name of the dataset in which to store the indices for non-zero elements. Defaults to "indices".

◆ ptr_name

std::string tatami_hdf5::WriteCompressedSparseMatrixOptions::ptr_name

Name of the dataset in which to store the column/row pointers. Defaults to "indptr".

◆ columnar

WriteStorageLayout tatami_hdf5::WriteCompressedSparseMatrixOptions::columnar = WriteStorageLayout::AUTOMATIC

Whether to save in the compressed sparse column layout. If false, this is determined from the layout of the input matrix.

◆ data_type

WriteStorageType tatami_hdf5::WriteCompressedSparseMatrixOptions::data_type = WriteStorageType::AUTOMATIC

Storage type for the data values. If AUTOMATIC, it is automatically determined from the range and integralness of the data in the input matrix.

◆ force_integer

bool tatami_hdf5::WriteCompressedSparseMatrixOptions::force_integer = false

Whether to force non-integer floating point values into an integer storage mode. Only relevant if data_type is set to AUTOMATIC. If true and/or all values are integers, the smallest integer storage mode that fits the (truncated) floats is used. If false and any non-integer values are detected, the DOUBLE storage mode is used instead.

◆ index_type

WriteStorageType tatami_hdf5::WriteCompressedSparseMatrixOptions::index_type = WriteStorageType::AUTOMATIC

Storage type for the data values. If AUTOMATIC, it is automatically determined from the range of the indices in the input matrix.

◆ deflate_level

int tatami_hdf5::WriteCompressedSparseMatrixOptions::deflate_level = 6

Compression level.

◆ chunk_size

hsize_t tatami_hdf5::WriteCompressedSparseMatrixOptions::chunk_size = sanisizer::cap<hsize_t>(100000)

Size of the chunks used for compression.

◆ num_threads

int tatami_hdf5::WriteCompressedSparseMatrixOptions::num_threads = 1

Number of threads to use for the first pass through the input matrix. This is only used to determine the number of non-zero elements (and infer an appropriate storage type, if an AUTOMATIC selection is requested).

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

tatami_hdf5/write_compressed_sparse_matrix.hpp

Public Attributes