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

Simple wrapper for an in-memory matrix. More...

#include <Matrix.hpp>

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

Collaboration diagram for knncolle::SimpleMatrix< Index_, Data_ >:

Public Member Functions
	SimpleMatrix (size_t num_dimensions, Index_ num_observations, const Data_ *data)
Index_	num_observations () const
size_t	num_dimensions () const
std::unique_ptr< MatrixExtractor< Data_ > >	new_extractor () const
Public Member Functions inherited from knncolle::Matrix< Index_, Data_ >

Detailed Description

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

Simple wrapper for an in-memory matrix.

This defines a simple column-major matrix of observations where the columns are observations and the rows are dimensions. It is compatible with the compile-time interface described in MockMatrix.

Template Parameters

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

Constructor & Destructor Documentation

SimpleMatrix()

template<typename Index_ , typename Data_ >

knncolle::SimpleMatrix< Index_, Data_ >::SimpleMatrix ( size_t num_dimensions, Index_ num_observations, const Data_ * data )

inline

Parameters

	num_dimensions	Number of dimensions.
	num_observations	Number of observations.
[in]	data	Pointer to an array of length num_dim * num_obs, containing a column-major matrix of observation data. It is expected that the array will not be deallocated during the lifetime of this SimpleMatrix instance.

Member Function Documentation

new_extractor()

template<typename Index_ , typename Data_ >

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

inlinevirtual

Returns

A new consecutive-access extractor.

Implements knncolle::Matrix< Index_, Data_ >.

num_dimensions()

template<typename Index_ , typename Data_ >

size_t knncolle::SimpleMatrix< Index_, Data_ >::num_dimensions ( ) const

inlinevirtual

Returns

Number of dimensions.

Implements knncolle::Matrix< Index_, Data_ >.

num_observations()

template<typename Index_ , typename Data_ >

Index_ knncolle::SimpleMatrix< Index_, Data_ >::num_observations ( ) const

inlinevirtual

Returns

Number of observations.

Implements knncolle::Matrix< Index_, Data_ >.

---

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

• knncolle/Matrix.hpp