TopQueue.hpp

Go to the documentation of this file.

#ifndef TOPICKS_TOP_QUEUE_HPP
#define TOPICKS_TOP_QUEUE_HPP
 
#include <vector>
#include <algorithm>
#include <optional>
#include <limits>
#include <cmath>
#include <cstddef>
 
#include "sanisizer/sanisizer.hpp"
 
namespace topicks {
 
template<typename Stat_>
struct TopQueueOptions {
    std::optional<Stat_> bound;
 
    bool open_bound = true;
 
    bool keep_ties = true;
 
    bool check_nan = false;
 
    std::optional<std::size_t> reserve;
};
 
template<typename Stat_, typename Index_>
class TopQueue {
private:
    typedef std::pair<Stat_, Index_> Element;
    std::vector<Element> my_queue, my_ties;
 
    struct SortGreater {
        bool operator()(const Element& left, const Element& right) const {
            if (left.first == right.first) {
                return left.second < right.second;
            } else {
                return left.first > right.first;
            }
        }
    };
 
    struct SortLess {
        bool operator()(const Element& left, const Element& right) const {
            if (left.first == right.first) {
                return left.second < right.second;
            } else {
                return left.first < right.first;
            }
        }
    };
 
    struct SortTies {
        bool operator()(const Element& left, const Element& right) const {
            return left.second < right.second;
        }
    };
 
    Index_ my_top;
    bool my_larger;
    std::optional<Stat_> my_bound; 
    bool my_open_bound;
    bool my_keep_ties;
    bool my_check_nan;
 
private:
    template<class Compare_, class Skip_>
    void push_internal(std::pair<Stat_, Index_> gene, const Compare_ cmp, const Skip_ skip) {
        if (my_bound.has_value()) {
            if (skip(*my_bound, gene.first)) {
                return;
            } else if (my_open_bound && *my_bound == gene.first) {
                return;
            }
        }
 
        if constexpr(std::numeric_limits<Stat_>::has_quiet_NaN) {
            if (my_check_nan && std::isnan(gene.first)) {
                return;
            }
        }
 
        if (sanisizer::is_less_than(my_queue.size(), my_top)) {
            my_queue.push_back(std::move(gene));
            std::push_heap(my_queue.begin(), my_queue.end(), cmp);
            return;
        }
 
        if (my_top == 0) {
            return;
        }
        const auto& top = my_queue.front();
        if (skip(top.first, gene.first)) {
            return;
        }
 
        if (!my_keep_ties) {
            if (top.first != gene.first || gene.second < top.second) {
                std::pop_heap(my_queue.begin(), my_queue.end(), cmp);
                my_queue.back() = std::move(gene);
                std::push_heap(my_queue.begin(), my_queue.end(), cmp);
            }
            return;
        }
 
        if (top.first == gene.first) {
            // Always making sure that all elements in my_ties are of equal or lower priority than the tied element in my_queue.
            if (gene.second >= top.second) {
                my_ties.push_back(std::move(gene));
                std::push_heap(my_ties.begin(), my_ties.end(), SortTies());
            } else {
                auto retop = top;
                std::pop_heap(my_queue.begin(), my_queue.end(), cmp);
                my_queue.back() = std::move(gene);
                std::push_heap(my_queue.begin(), my_queue.end(), cmp);
                my_ties.push_back(std::move(retop));
                std::push_heap(my_ties.begin(), my_ties.end(), SortTies());
            }
            return;
        }
 
        if (my_top == 1) {
            my_queue.front() = std::move(gene);
            return;
        }
 
        // The idea is to check whether the top 2 elements of the queue are tied,
        // and if so, shift the top value into the tie queue.
        auto retop = top;
        std::pop_heap(my_queue.begin(), my_queue.end(), cmp);
        if (retop.first == my_queue.front().first) {
            my_ties.push_back(std::move(retop));
            std::push_heap(my_ties.begin(), my_ties.end(), SortTies());
        } else {
            my_ties.clear();
        }
        my_queue.back() = std::move(gene);
        std::push_heap(my_queue.begin(), my_queue.end(), cmp);
    }
 
    template<class Compare_>
    void pop_internal(Compare_ cmp) {
        if (my_ties.size()) {
            std::pop_heap(my_ties.begin(), my_ties.end(), SortTies());
            my_ties.pop_back();
        } else {
            std::pop_heap(my_queue.begin(), my_queue.end(), cmp);
            my_queue.pop_back();
        }
    }
 
public:
    TopQueue(const Index_ top, const bool larger, const TopQueueOptions<Stat_>& options) : 
        my_top(top),
        my_larger(larger),
        my_bound(options.bound),
        my_open_bound(options.open_bound),
        my_keep_ties(options.keep_ties),
        my_check_nan(options.check_nan)
    {
        if (options.reserve.has_value()) {
            my_queue.reserve(*(options.reserve));
        } else {
            my_queue.reserve(my_top);
        }
    }
 
    void push(std::pair<Stat_, Index_> gene) {
        if (my_larger) {
            push_internal(
                std::move(gene), 
                SortGreater(),
                [](const Stat_ existing, const Stat_ latest) -> bool { return existing > latest; }
            );
        } else {
            push_internal(
                std::move(gene),
                SortLess(),
                [](const Stat_ existing, const Stat_ latest) -> bool { return existing < latest; }
            );
        }
    }
 
    void emplace(Stat_ statistic, Index_ index) {
        push({ statistic, index });
    }
 
    Index_ size() const {
        return my_queue.size() + my_ties.size();
    }
 
    bool empty() const {
        return size() == 0;
    }
 
    const std::pair<Stat_, Index_>& top() const {
        if (my_ties.size()) {
            return my_ties.front();
        } else {
            return my_queue.front();
        }
    }
 
    void pop() {
        if (my_larger) {
            pop_internal(SortGreater());
        } else {
            pop_internal(SortLess());
        }
    }
};
 
}
 
#endif