Extractor.hpp

Go to the documentation of this file.

#ifndef TATAMI_EXTRACTOR_HPP
#define TATAMI_EXTRACTOR_HPP
 
#include <vector>
#include <type_traits>
#include "SparseRange.hpp"
#include "Options.hpp"
 
namespace tatami {
 
template<typename Value_, typename Index_>
class MyopicDenseExtractor {
public:
    virtual const Value_* fetch(Index_ i, Value_* buffer) = 0;
 
    MyopicDenseExtractor() = default;
    MyopicDenseExtractor(const MyopicDenseExtractor&) = default;
    MyopicDenseExtractor& operator=(const MyopicDenseExtractor&) = default;
    MyopicDenseExtractor(MyopicDenseExtractor&&) = default;
    MyopicDenseExtractor& operator=(MyopicDenseExtractor&&) = default;
    virtual ~MyopicDenseExtractor() = default;
    // No-op for back-compatibility only.
    template<class Oracle_>
    void set_oracle(Oracle_) {}
};
 
template<typename Value_, typename Index_>
class OracularDenseExtractor {
public:
    const Value_* fetch(Value_* buffer) {
        return fetch(0, buffer);
    }
 
    virtual const Value_* fetch(Index_ i, Value_* buffer) = 0;
 
    OracularDenseExtractor() = default;
    OracularDenseExtractor(const OracularDenseExtractor&) = default;
    OracularDenseExtractor& operator=(const OracularDenseExtractor&) = default;
    OracularDenseExtractor(OracularDenseExtractor&&) = default;
    OracularDenseExtractor& operator=(OracularDenseExtractor&&) = default;
    virtual ~OracularDenseExtractor() = default;
    // No-op for back-compatibility only.
    template<class Oracle_>
    void set_oracle(Oracle_) {}
};
 
template<typename Value_, typename Index_>
class MyopicSparseExtractor {
public:
    virtual SparseRange<Value_, Index_> fetch(Index_ i, Value_* value_buffer, Index_* index_buffer) = 0;
 
    MyopicSparseExtractor() = default;
    MyopicSparseExtractor(const MyopicSparseExtractor&) = default;
    MyopicSparseExtractor& operator=(const MyopicSparseExtractor&) = default;
    MyopicSparseExtractor(MyopicSparseExtractor&&) = default;
    MyopicSparseExtractor& operator=(MyopicSparseExtractor&&) = default;
    virtual ~MyopicSparseExtractor() = default;
    // No-op for back-compatibility only.
    template<class Oracle_>
    void set_oracle(Oracle_) {}
};
 
template<typename Value_, typename Index_>
class OracularSparseExtractor {
public:
    SparseRange<Value_, Index_> fetch(Value_* value_buffer, Index_* index_buffer) {
        return fetch(0, value_buffer, index_buffer);
    }
 
    virtual SparseRange<Value_, Index_> fetch(Index_ i, Value_* value_buffer, Index_* index_buffer) = 0;
 
    OracularSparseExtractor() = default;
    OracularSparseExtractor(const OracularSparseExtractor&) = default;
    OracularSparseExtractor& operator=(const OracularSparseExtractor&) = default;
    OracularSparseExtractor(OracularSparseExtractor&&) = default;
    OracularSparseExtractor& operator=(OracularSparseExtractor&&) = default;
    virtual ~OracularSparseExtractor() = default;
    // No-op for back-compatibility only.
    template<class Oracle_>
    void set_oracle(Oracle_) {}
};
 
template<bool oracle_, typename Value_, typename Index_>
using DenseExtractor = typename std::conditional<oracle_, OracularDenseExtractor<Value_, Index_>, MyopicDenseExtractor<Value_, Index_> >::type;
 
template<bool oracle_, typename Value_, typename Index_>
using SparseExtractor = typename std::conditional<oracle_, OracularSparseExtractor<Value_, Index_>, MyopicSparseExtractor<Value_, Index_> >::type;
 
}
 
#endif