knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ > Class Template Reference

knncolle-compatible wrapper around a tatami matrix. More...

#include <knncolle_tatami.hpp>

Inheritance diagram for knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >:

Collaboration diagram for knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >:

Public Member Functions
	Matrix (MatrixPointer_ matrix, bool transposed)
KIndex_	num_observations () const
std::size_t	num_dimensions () const
std::unique_ptr< knncolle::MatrixExtractor< KData_ > >	new_extractor () const
auto	new_known_extractor () const
Public Member Functions inherited from knncolle::Matrix< KIndex_, KData_ >
auto	new_known_extractor () const

Detailed Description

template<typename KIndex_, typename KData_, typename TValue_, typename TIndex_, class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>
class knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >

knncolle-compatible wrapper around a tatami matrix.

Template Parameters

KIndex_	Integer type of observation indices for knncolle.
KData_	Numeric type of the data for knncolle.
TValue_	Numeric type of matrix values for tatami.
TIndex_	Integer type of the row/column indices for tatami.
MatrixPointer_	Pointer to a tatami::Matrix. This may be a smart or raw pointer class.

Pretty much as it says on the tin - implements a knncolle::Matrix subclass to wrap a tatami::Matrix. The idea is to enable the use of arbitrary tatami matrix representations in knncolle functions, e.g., to create a search index from a file-backed matrix.

Constructor & Destructor Documentation

Matrix()

template<typename KIndex_ , typename KData_ , typename TValue_ , typename TIndex_ , class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>

knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >::Matrix ( MatrixPointer_ matrix, bool transposed )

inline

Parameters

matrix	Raw or smart pointer to a tatami::Matrix.
transposed	Whether to transpose the matrix during extraction in kmeans functions. If true, new_extractor() will extract rows instead of columns.

Member Function Documentation

new_extractor()

template<typename KIndex_ , typename KData_ , typename TValue_ , typename TIndex_ , class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>

std::unique_ptr< knncolle::MatrixExtractor< KData_ > > knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >::new_extractor ( ) const

inlinevirtual

Implements knncolle::Matrix< KIndex_, KData_ >.

new_known_extractor()

template<typename KIndex_ , typename KData_ , typename TValue_ , typename TIndex_ , class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>

auto knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >::new_known_extractor ( ) const

inline

Override to assist devirtualization.

num_dimensions()

template<typename KIndex_ , typename KData_ , typename TValue_ , typename TIndex_ , class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>

std::size_t knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >::num_dimensions ( ) const

inlinevirtual

Implements knncolle::Matrix< KIndex_, KData_ >.

num_observations()

template<typename KIndex_ , typename KData_ , typename TValue_ , typename TIndex_ , class MatrixPointer_ = std::shared_ptr<const tatami::Matrix<TValue_, TIndex_> >>

KIndex_ knncolle_tatami::Matrix< KIndex_, KData_, TValue_, TIndex_, MatrixPointer_ >::num_observations ( ) const

inlinevirtual

Implements knncolle::Matrix< KIndex_, KData_ >.

---

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

• knncolle_tatami/knncolle_tatami.hpp