tatami::CompressedSparseMatrixOptions Struct Reference

Options for the CompressedSparseMatrix. More...

#include <CompressedSparseMatrix.hpp>

Public Attributes
bool	check = true

Detailed Description

Options for the CompressedSparseMatrix.

Member Data Documentation

check

bool tatami::CompressedSparseMatrixOptions::check = true

Should the input vectors of indices and pointers be checked for validity in the CompressedSparseMatrix constructor? If true, the constructor will check that:

• values and indices have the same length, equal to the number of structural non-zero elements.
• pointers has length equal to the number of rows (if csr = true) or columns (otherwise) plus one.
• pointers is non-decreasing with first and last values set to 0 and the number of structural non-zeroes, respectively.
• indices is strictly increasing within each interval defined by successive elements of pointers.
• all values of indices are non-negative and less than the number of columns (if csr = true) or rows (otherwise).

This can be disabled for faster construction if the caller is certain that the input is valid.

---

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

• tatami/sparse/CompressedSparseMatrix.hpp