heap.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_HEAP_H
#define GUM_HEAP_H
 
#include <functional>
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <initializer_list>
 
namespace gum {
 
#define GUM_HEAP_DEFAULT_CAPACITY 10
 
  // templates provided by this file
 
  template < typename Val, typename Cmp >
  class Heap;
  template < typename Val, typename Cmp >
  std::ostream& operator<<(std::ostream&, const Heap< Val, Cmp >&);
 
  // ===========================================================================
  // ===                      SIMPLE HEAP DATA STRUCTURE                     ===
  // ===========================================================================

  template < typename Val, typename Cmp = std::less< Val > >
  class Heap {
    public:
    using value_type      = Val;
    using reference       = Val&;
    using const_reference = const Val&;
    using pointer         = Val*;
    using const_pointer   = const Val*;
    using size_type       = std::size_t;
    using difference_type = std::ptrdiff_t;
 
    // ============================================================================
    // ============================================================================

    explicit Heap(Cmp compare = Cmp(), Size capacity = GUM_HEAP_DEFAULT_CAPACITY);

    explicit Heap(std::initializer_list< Val > list);

    Heap(const Heap< Val, Cmp >& from);

    Heap(Heap< Val, Cmp >&& from) noexcept;

    ~Heap();

    // ============================================================================
    // ============================================================================

    Heap< Val, Cmp >& operator=(const Heap< Val, Cmp >& from);

    Heap< Val, Cmp >& operator=(Heap< Val, Cmp >&& from) noexcept;

    const Val& operator[](Size index_elt) const;

    // ============================================================================
    // ============================================================================

    const Val& top() const;

    Val pop();

    void eraseTop();

    void eraseByPos(Size index);

    void erase(const Val& val);

    Size insert(const Val& val);

    Size insert(Val&& val);

    template < typename... Args >
    Size emplace(Args&&... args);

    Size size() const noexcept;

    bool empty() const noexcept;

    bool contains(const Val&) const;

    std::string toString() const;

    // ============================================================================
    // ============================================================================

    Size capacity() const noexcept;

    void resize(Size new_size);

 
    private:
    std::vector< Val > _heap_;

    Size _nb_elements_{0};

    Cmp _cmp_;

    Size _restoreHeap_();
  };
 
} /* namespace gum */
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::Heap< int >;
extern template class gum::Heap< long >;
extern template class gum::Heap< double >;
#endif
 
 
// always include the implementation of the templates
#include <agrum/base/core/heap_tpl.h>
 
#endif /* GUM_HEAP_H */