knncolle::Matrix< Index_, Data_ > Class Template Reference

Interface for matrix data. More...

#include <Matrix.hpp>

Inheritance diagram for knncolle::Matrix< Index_, Data_ >:

Public Member Functions
virtual Index_	num_observations () const =0
virtual std::size_t	num_dimensions () const =0
virtual std::unique_ptr< MatrixExtractor< Data_ > >	new_extractor () const =0
auto	new_known_extractor () const

Detailed Description

template<typename Index_, typename Data_>
class knncolle::Matrix< Index_, Data_ >

Interface for matrix data.

This defines the expectations for a matrix of observation-level data to be used in Builder::build_raw().

Template Parameters

Index_	Integer type of the observation indices.
Data_	Numeric type of the data.

Member Function Documentation

new_extractor()

template<typename Index_ , typename Data_ >

virtual std::unique_ptr< MatrixExtractor< Data_ > > knncolle::Matrix< Index_, Data_ >::new_extractor ( ) const

pure virtual

Returns

A new consecutive-access extractor.

Implemented in knncolle::L2NormalizedMatrix< Index_, Data_, Normalized_, Matrix_ >, and knncolle::SimpleMatrix< Index_, Data_ >.

new_known_extractor()

template<typename Index_ , typename Data_ >

auto knncolle::Matrix< Index_, Data_ >::new_known_extractor ( ) const

inline

Returns

A new consecutive-access extractor.

Subclasses may override this method to return a pointer to a specific MatrixExtractor subclass. This is used for devirtualization in other knncolle functions. If no override is provided, new_extractor() is called instead.

num_dimensions()

template<typename Index_ , typename Data_ >

virtual std::size_t knncolle::Matrix< Index_, Data_ >::num_dimensions ( ) const

pure virtual

Returns

Number of dimensions.

Implemented in knncolle::L2NormalizedMatrix< Index_, Data_, Normalized_, Matrix_ >, and knncolle::SimpleMatrix< Index_, Data_ >.

num_observations()

template<typename Index_ , typename Data_ >

virtual Index_ knncolle::Matrix< Index_, Data_ >::num_observations ( ) const

pure virtual

Returns

Number of observations.

Implemented in knncolle::L2NormalizedMatrix< Index_, Data_, Normalized_, Matrix_ >, and knncolle::SimpleMatrix< Index_, Data_ >.

---

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

• knncolle/Matrix.hpp