knncolle
Collection of KNN methods in C++
Loading...
Searching...
No Matches
knncolle::Matrix< Index_, Data_ > Class Template Referenceabstract

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 size_t num_dimensions () const =0
 
virtual std::unique_ptr< MatrixExtractor< Data_ > > new_extractor () const =0
 

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::SimpleMatrix< Index_, Data_ >.

◆ num_dimensions()

template<typename Index_ , typename Data_ >
virtual size_t knncolle::Matrix< Index_, Data_ >::num_dimensions ( ) const
pure virtual
Returns
Number of dimensions.

Implemented in 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::SimpleMatrix< Index_, Data_ >.


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