tatami::Oracle< Index_ > Class Template Reference

Predict future access requests on the target dimension. More...

#include <Oracle.hpp>

Inheritance diagram for tatami::Oracle< Index_ >:

Public Member Functions
virtual PredictionIndex	total () const =0
virtual Index_	get (PredictionIndex i) const =0

Detailed Description

template<typename Index_>
class tatami::Oracle< Index_ >

Predict future access requests on the target dimension.

Template Parameters

Index_

Integer type of the row/column indices.

This allows Matrix implementations to pre-fetch data for future requests to OracularDenseExtractor::fetch() or OracularSparseExtractor::fetch(). Check out ConsecutiveOracle and FixedVectorOracle for some examples of concrete subclasses.

Member Function Documentation

total()

template<typename Index_ >

virtual PredictionIndex tatami::Oracle< Index_ >::total ( ) const

pure virtual

Returns

Total number of predictions.

Implemented in tatami::ConsecutiveOracle< Index_ >, tatami::FixedVectorOracle< Index_ >, and tatami::FixedViewOracle< Index_ >.

get()

template<typename Index_ >

virtual Index_ tatami::Oracle< Index_ >::get ( PredictionIndex i ) const

pure virtual

Parameters

i	Which prediction to return.

Returns

The i-th prediction, to be interpreted as an index on the target dimension.

Implemented in tatami::ConsecutiveOracle< Index_ >, tatami::FixedVectorOracle< Index_ >, and tatami::FixedViewOracle< Index_ >.

---

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

• tatami/base/Oracle.hpp