tatami::CompressedSparseContents< Value_, Index_, Pointer_ > Struct Template Reference

Compressed sparse contents. More...

#include <convert_to_compressed_sparse.hpp>

Public Attributes
std::vector< Value_ >	value
std::vector< Index_ >	index
std::vector< Pointer_ >	pointers

Detailed Description

template<typename Value_, typename Index_, typename Pointer_ = size_t>
struct tatami::CompressedSparseContents< Value_, Index_, Pointer_ >

Compressed sparse contents.

Template Parameters

Value_	Type of value in the matrix.
Index_	Type of row/column index.
Pointer_	Integer type for the row/column pointers.

The "primary" dimension is the one that is used to create the pointers for the compressed sparse format, while the other dimension is defined as the "secondary" dimension. For example, the rows would be the primary dimension in a compressed sparse row matrix.

Member Data Documentation

value

template<typename Value_ , typename Index_ , typename Pointer_ = size_t>

std::vector<Value_> tatami::CompressedSparseContents< Value_, Index_, Pointer_ >::value

Vector containing values of the structural non-zero elements in a compressed sparse format.

index

template<typename Value_ , typename Index_ , typename Pointer_ = size_t>

std::vector<Index_> tatami::CompressedSparseContents< Value_, Index_, Pointer_ >::index

Vector containing the secondary dimension indices of the structural non-zero elements in a compressed sparse format.

pointers

template<typename Value_ , typename Index_ , typename Pointer_ = size_t>

std::vector<Pointer_> tatami::CompressedSparseContents< Value_, Index_, Pointer_ >::pointers

Vector containing the pointers for each primary dimension element in a compressed sparse format.

---

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

• tatami/sparse/convert_to_compressed_sparse.hpp