tatami::FixedViewOracle< Index_ > Class Template Reference

Predict future accesses from a view on a fixed sequence. More...

#include <FixedOracle.hpp>

Inheritance diagram for tatami::FixedViewOracle< Index_ >:

Collaboration diagram for tatami::FixedViewOracle< Index_ >:

Public Member Functions
	FixedViewOracle (const Index_ *const ptr, const PredictionIndex number)
PredictionIndex	total () const
Index_	get (PredictionIndex i) const
Public Member Functions inherited from tatami::Oracle< Index_ >

Detailed Description

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

Predict future accesses from a view on a fixed sequence.

Template Parameters

Index_

Integer type of the row/column indices.

Constructor & Destructor Documentation

FixedViewOracle()

template<typename Index_ >

tatami::FixedViewOracle< Index_ >::FixedViewOracle ( const Index_ *const ptr, const PredictionIndex number )

inline

Parameters

ptr	Pointer to a constant array of indices on the target dimension. The underlying array should be valid for the lifetime of this FixedViewOracle instance.
number	Length of the array at ptr.

Member Function Documentation

total()

template<typename Index_ >

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

inlinevirtual

Returns

Total number of predictions.

Implements tatami::Oracle< Index_ >.

get()

template<typename Index_ >

Index_ tatami::FixedViewOracle< 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/FixedOracle.hpp