tatami::ConsecutiveOracle< Index_ > Class Template Reference

Predict future accesses along a consecutive sequence. More...

#include <ConsecutiveOracle.hpp>

Inheritance diagram for tatami::ConsecutiveOracle< Index_ >:

Collaboration diagram for tatami::ConsecutiveOracle< Index_ >:

Public Member Functions
	ConsecutiveOracle (const Index_ start, const Index_ length)
PredictionIndex	total () const
Index_	get (PredictionIndex i) const
Public Member Functions inherited from tatami::Oracle< Index_ >

Detailed Description

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

Predict future accesses along a consecutive sequence.

Template Parameters

Index_

Integer type of the row/column indices.

Constructor & Destructor Documentation

ConsecutiveOracle()

template<typename Index_ >

tatami::ConsecutiveOracle< Index_ >::ConsecutiveOracle ( const Index_ start, const Index_ length )

inline

Parameters

start	Start index of the consecutive sequence on the target dimension.
length	Length of the sequence.

Member Function Documentation

total()

template<typename Index_ >

PredictionIndex tatami::ConsecutiveOracle< Index_ >::total ( ) const

inlinevirtual

Returns

Total number of predictions.

Implements tatami::Oracle< Index_ >.

get()

template<typename Index_ >

Index_ tatami::ConsecutiveOracle< Index_ >::get ( PredictionIndex i ) const

inlinevirtual

Parameters

i	Which prediction to return.

Returns

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

Implements tatami::Oracle< Index_ >.

---

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

• tatami/utils/ConsecutiveOracle.hpp