heap.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_HEAP_H
#define GUM_HEAP_H

#include <functional>
#include <initializer_list>
#include <utility>
#include <vector>

#include <agrum/agrum.h>

namespace gum {

#define GUM_HEAP_DEFAULT_CAPACITY 10

  // templates provided by this file

  template < typename Val, typename Cmp, typename Alloc >
  class Heap;
  template < typename Val, typename Cmp, typename Alloc >
  std::ostream& operator<<(std::ostream&, const Heap< Val, Cmp, Alloc >&);

  // ===========================================================================
  // ===                      SIMPLE HEAP DATA STRUCTURE                     ===
  // ===========================================================================

  template < typename Val,
             typename Cmp = std::less< Val >,
             typename Alloc = std::allocator< 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;
    using allocator_type = Alloc;

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

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

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

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

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

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

    ~Heap();

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

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

    template < typename OtherAlloc >
    Heap< Val, Cmp, Alloc >& operator=(const Heap< Val, Cmp, OtherAlloc >& from);

    Heap< Val, Cmp, Alloc >& operator=(Heap< Val, Cmp, Alloc >&& 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, Alloc > __heap;

    Size __nb_elements{0};

    Cmp __cmp;

    Size __restoreHeap();
  };

} /* namespace gum */


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::Heap< int >;
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::Heap< long >;
#    endif
#  endif
#endif

#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::Heap< double >;
#    endif
#  endif
#endif


// always include the implementation of the templates
#include <agrum/core/heap_tpl.h>

#endif /* GUM_HEAP_H */