PriorityQueue.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright © 2014-2024 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// Reaktoro includes
#include <Reaktoro/Common/Types.hpp>
 
namespace Reaktoro {
 
// A queue organized based on priorities that can change dynamically.
class PriorityQueue
{
public:
    PriorityQueue();
 
    static auto withInitialSize(Index size) -> PriorityQueue;
 
    static auto withInitialPriorities(Deque<Index> const& priorities) -> PriorityQueue;
 
    static auto withInitialOrder(Deque<Index> const& order) -> PriorityQueue;
 
    static auto withInitialPrioritiesAndOrder(Deque<Index> const& priorities, Deque<Index> const& order) -> PriorityQueue;
 
    auto size() const -> Index;
 
    auto reset() -> void;
 
    auto increment(Index identity) -> void;
 
    auto extend() -> void;
 
    auto priorities() const -> Deque<Index> const&;
 
    auto order() const -> Deque<Index> const&;
 
private:
    Deque<Index> _priorities;
 
    Deque<Index> _order;
};
 
} // namespace Reaktoro