tatami::PseudoOracularDenseExtractor< Value_, Index_ > Struct Template Reference

Mimic the OracularDenseExtractor interface. More...

#include <PseudoOracularExtractor.hpp>

Inheritance diagram for tatami::PseudoOracularDenseExtractor< Value_, Index_ >:

Collaboration diagram for tatami::PseudoOracularDenseExtractor< Value_, Index_ >:

Public Member Functions
	PseudoOracularDenseExtractor (std::shared_ptr< const Oracle< Index_ > > oracle, std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > > ext)
const Value_ *	fetch (Index_, Value_ *buffer)
Public Member Functions inherited from tatami::OracularDenseExtractor< Value_, Index_ >
const Value_ *	fetch (Value_ *buffer)

Detailed Description

template<typename Value_, typename Index_>
struct tatami::PseudoOracularDenseExtractor< Value_, Index_ >

Mimic the OracularDenseExtractor interface.

Template Parameters

Value_	Data value type, should be numeric.
Index_	Row/column index type, should be integer.

This is used to quickly implement the dense extraction methods for a Matrix subclass that does not benefit from an Oracle. Specifically, the oracle is used to generate a prediction that is passed to an oracle-unaware MyopicDenseExtractor. This allows Matrix subclasses to satisfy the dense oracle-aware extraction interface.

Constructor & Destructor Documentation

PseudoOracularDenseExtractor()

template<typename Value_ , typename Index_ >

tatami::PseudoOracularDenseExtractor< Value_, Index_ >::PseudoOracularDenseExtractor ( std::shared_ptr< const Oracle< Index_ > >  oracle, std::unique_ptr< MyopicDenseExtractor< Value_, Index_ > >  ext  )

inline

Parameters

oracle	The oracle.
ext	A dense extractor to extract dimension elements according to ora.

Member Function Documentation

fetch()

template<typename Value_ , typename Index_ >

const Value_ * tatami::PseudoOracularDenseExtractor< Value_, Index_ >::fetch ( Index_  i, Value_ *  buffer  )

inlinevirtual

This overload is intended for developers only. It introduces the i argument so that the signature is the same as that of MyopicDenseExtractor::fetch(). This makes it easier to define MyopicDenseExtractor and OracularDenseExtractor subclasses from a single template, avoiding code duplication that would otherwise occur when defining methods with and without i. Of course, implementations are expected to ignore i in oracle-aware extraction.

Other than the extra i argument, all other behaviors of the two overloads are the same. To avoid confusion, most users should just use the fetch() overload that does not accept i, given that the value of i is never actually used.

Parameters

	i	Ignored, only provided for consistency with MyopicDenseExtractor::fetch(),
[out]	buffer	Pointer to an array of length no less than N, where N is defined as described for MyopicDenseExtractor::fetch().

Returns

Pointer to an array containing the contents of the next dimension element, as predicted by the Oracle used to construct this instance. This is guaranteed to have N values.

Implements tatami::OracularDenseExtractor< Value_, Index_ >.

---

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

• tatami/utils/PseudoOracularExtractor.hpp