kmeans::ConsecutiveAccessExtractor< Index_, Data_ > Class Template Reference

Extractor for accessing consecutive observations. More...

#include <Matrix.hpp>

Public Member Functions
virtual const Data_ *	get_observation ()=0

Detailed Description

template<typename Index_, typename Data_>
class kmeans::ConsecutiveAccessExtractor< Index_, Data_ >

Extractor for accessing consecutive observations.

This is typically generated by the Matrix::new_extractor() overload the accepts a start and length parameter. It can be assumed that the lifetime of each extractor will not exceed that of its parent Matrix.

Template Parameters

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

Member Function Documentation

get_observation()

template<typename Index_ , typename Data_ >

virtual const Data_ * kmeans::ConsecutiveAccessExtractor< Index_, Data_ >::get_observation ( )

pure virtual

Returns

Pointer to an array of length equal to Matrix::num_dimensions(), containing the coordinates for the next observation.

The first call to this method should return the coordinates of the start observation from Matrix::new_extractor(). The next call should return start + 1, etc. until a maximum of length calls have been performed.

This method will only be called within a single thread and may modify internal data members of a ConsecutiveAccessExtractor subclass.

---

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

• kmeans/Matrix.hpp