Compressed sparse column matrix. More...

#include <CompressedSparseMatrix.hpp>

Inheritance diagram for tatami::CompressedSparseColumnMatrix< Value_, Index_, ValueStorage_, IndexStorage_, PointerStorage_ >:

[legend]

Collaboration diagram for tatami::CompressedSparseColumnMatrix< Value_, Index_, ValueStorage_, IndexStorage_, PointerStorage_ >:

[legend]

Public Member Functions
	CompressedSparseColumnMatrix (Index_ nrow, Index_ ncol, ValueStorage_ values, IndexStorage_ indices, PointerStorage_ pointers, bool check=true)

Public Member Functions inherited from tatami::CompressedSparseMatrix< Value_, Index_, ValueStorage_, IndexStorage_, PointerStorage_ >
	CompressedSparseMatrix (Index_ nrow, Index_ ncol, ValueStorage_ values, IndexStorage_ indices, PointerStorage_ pointers, bool csr, bool check=true)

Index_	nrow () const

Index_	ncol () const

bool	is_sparse () const

double	is_sparse_proportion () const

bool	prefer_rows () const

double	prefer_rows_proportion () const

bool	uses_oracle (bool) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense (bool row, const Options &) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense (bool row, Index_ block_start, Index_ block_end, const Options &) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense (bool row, VectorPtr< Index_ > indices_ptr, const Options &) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse (bool row, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse (bool row, Index_ block_start, Index_ block_end, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse (bool row, VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_end, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > my_indices_ptr, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_end, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse (bool row, std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > my_indices_ptr, const Options &opt) const

Public Member Functions inherited from tatami::Matrix< Value_, Index_ >
std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row () const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (Index_ block_start, Index_ block_length) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_row (std::vector< Index_ > indices) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_row (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column () const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (Index_ block_start, Index_ block_length) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >	dense_column (std::vector< Index_ > indices) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< OracularDenseExtractor< Value_, Index_ > >	dense_column (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row () const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (Index_ block_start, Index_ block_length) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_row (std::vector< Index_ > indices) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_row (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column () const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (Index_ block_start, Index_ block_length) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< MyopicSparseExtractor< Value_, Index_ > >	sparse_column (std::vector< Index_ > indices) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices, const Options &opt) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, Index_ block_start, Index_ block_length) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, VectorPtr< Index_ > indices_ptr) const

std::unique_ptr< OracularSparseExtractor< Value_, Index_ > >	sparse_column (std::shared_ptr< const Oracle< Index_ > > oracle, std::vector< Index_ > indices) const

Additional Inherited Members
Public Types inherited from tatami::Matrix< Value_, Index_ >
typedef Value_	value_type

typedef Index_	index_type

Detailed Description

template<typename Value_, typename Index_, class ValueStorage_ = std::vector<Value_>, class IndexStorage_ = std::vector<Index_>, class PointerStorage_ = std::vector<size_t>>
class tatami::CompressedSparseColumnMatrix< Value_, Index_, ValueStorage_, IndexStorage_, PointerStorage_ >

Compressed sparse column matrix.

See tatami::CompressedSparseMatrix for details on the template parameters.

Constructor & Destructor Documentation

◆ CompressedSparseColumnMatrix()

template<typename Value_ , typename Index_ , class ValueStorage_ = std::vector<Value_>, class IndexStorage_ = std::vector<Index_>, class PointerStorage_ = std::vector<size_t>>

tatami::CompressedSparseColumnMatrix< Value_, Index_, ValueStorage_, IndexStorage_, PointerStorage_ >::CompressedSparseColumnMatrix	(	Index_	nrow,
		Index_	ncol,
		ValueStorage_	values,
		IndexStorage_	indices,
		PointerStorage_	pointers,
		bool	check = `true`
	)

inline

Parameters

nrow	Number of rows.
ncol	Number of columns.
values	Vector of non-zero elements.
indices	Vector of row indices for the non-zero elements.
pointers	Vector of index pointers, of length equal to the number of columns plus 1.
check	Should the input vectors be checked for validity?

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

tatami/sparse/CompressedSparseMatrix.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CompressedSparseColumnMatrix()