NeighborIterator.hpp

Go to the documentation of this file.

#ifndef BIFROST_NEIGHBOR_ITERATOR_HPP
#define BIFROST_NEIGHBOR_ITERATOR_HPP
 
#include "Kmer.hpp"
 
template<typename U, typename G> class CompactedDBG;
template<typename U, typename G, bool is_const> class UnitigMap;
 
template<typename Unitig_data_t = void, typename Graph_data_t = void, bool is_const = false>
class neighborIterator : public std::iterator<std::input_iterator_tag, UnitigMap<Unitig_data_t, Graph_data_t, is_const>, int> {
 
    typedef Unitig_data_t U;
    typedef Graph_data_t G;
 
    public:
 
        typedef typename std::conditional<is_const, const CompactedDBG<U, G>*, CompactedDBG<U, G>*>::type CompactedDBG_ptr_t;
 
        neighborIterator();
 
        neighborIterator(const UnitigMap<U, G, is_const>& um_, const bool is_forward_);
 
        neighborIterator(const neighborIterator& o);
 
        neighborIterator& operator++();
 
        neighborIterator operator++(int);
 
        bool operator==(const neighborIterator& o) const;
 
        bool operator!=(const neighborIterator& o) const;
 
        const UnitigMap<U, G, is_const>& operator*() const;
 
        const UnitigMap<U, G, is_const>* operator->() const;
 
    private:
 
        int i;
 
        bool is_fw;
 
        Kmer km_head;
        Kmer km_tail;
 
        UnitigMap<U, G, is_const> um;
 
        CompactedDBG_ptr_t cdbg;
};
 
template<typename Unitig_data_t = void, typename Graph_data_t = void, bool is_const = false>
class BackwardCDBG {
 
    typedef Unitig_data_t U;
    typedef Graph_data_t G;
 
    public:
 
        explicit BackwardCDBG(const UnitigMap<U, G, is_const>& um_);
 
        bool hasPredecessors() const;
 
        size_t cardinality() const;
 
        neighborIterator<U, G, is_const> begin() const;
 
        neighborIterator<U, G, is_const> end() const;
 
    private:
 
        UnitigMap<U, G, is_const> um;
};
 
template<typename Unitig_data_t = void, typename Graph_data_t = void, bool is_const = false>
class ForwardCDBG {
 
    typedef Unitig_data_t U;
    typedef Graph_data_t G;
 
    public:
 
        explicit ForwardCDBG(const UnitigMap<U, G, is_const>& um_);
 
        bool hasSuccessors() const;
 
        size_t cardinality() const;
 
        neighborIterator<U, G, is_const> begin() const;
 
        neighborIterator<U, G, is_const> end() const;
 
    private:
 
        UnitigMap<U, G, is_const> um;
};
 
#include "NeighborIterator.tcc"
 
#endif