tatami
C++ API for different matrix representations
Loading...
Searching...
No Matches
tatami::FragmentedSparseMatrixOptions Struct Reference

Options for FragmentedSparseMatrix(). More...

#include <FragmentedSparseMatrix.hpp>

Public Attributes

bool check = true
 

Detailed Description

Options for FragmentedSparseMatrix().

Member Data Documentation

◆ check

bool tatami::FragmentedSparseMatrixOptions::check = true

Should the input vectors be checked for validity in the FragmentedSparseMatrix constructor? If true, the constructor will check that:

  • values and indices have the same length that is equal to the number of rows (for row_sparse = true) or columns (otherwise).
  • corresponding elements of values and indices have the same length.
  • each element of indices is ordered and contains non-negative values less than ncol (for row_sparse = true) or nrow (otherwise).

This can be disabled for faster construction if the caller knows that the input vectors are valid.


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