main page namespaces classes files
ELL home

src/ell/util/PriorityQueue.hh

Go to the documentation of this file.

#ifndef PRIORITYQUEUE_HH_
#define PRIORITYQUEUE_HH_

#include <map>
#include <set>

#include "ell/State.hh"

namespace ell {
  namespace util {

    class QueueKey {
    public:
        double E;
        CSequence s; 
        bool operator<(const QueueKey& toCompare) const;
        
        QueueKey();
        QueueKey(const double E, const CSequence& s);
        ~QueueKey();
    };
    
        template<class QV // QueueValue of PriorityQueue_ as template parameter
                , class QK = QueueKey  // QueueKey with default
                , typename CompareKey = std::less<QK> > // comparison operator
        class PriorityQueue
    {
    public:
    
          // access to the template arguments
        typedef QV QueueValue;
        typedef QK QueueKey;
        
    protected:
        typedef typename std::map< QK, QV, CompareKey > InternalPQtype;
        
        InternalPQtype pq;
                
    public:
    
        typedef typename InternalPQtype::const_iterator const_iterator;
        typedef typename InternalPQtype::iterator iterator;
        typedef typename InternalPQtype::size_type size_type;
        typedef typename std::pair<iterator, bool> InsertResult;

        PriorityQueue();
        virtual ~PriorityQueue();
        
        const_iterator begin(void) const;
        const_iterator end(void) const;
    
        iterator begin(void);
        iterator end(void);
    
        const_iterator top(void) const;
        
        void pop(void);
        
        size_type size(void) const;
        
        bool empty(void) const;
        
        const_iterator find(const State* s) const;
        iterator find(const State* s);
        const_iterator find(const QK& key) const;
        iterator find(const QK& key);
    
        InsertResult insert(const State* keyState);
        InsertResult insert(const QK& key);
        
        void erase(const State* s);
        void erase(const QK& key);
        
        double getMaxE(void) const;
    
        void reduceMaxE(const double maxE);
    
    };

  } // namespace util
} // namespace ell

#include "ell/util/PriorityQueue.icc"

#endif /*PRIORITYQUEUE_HH_*/