boost_range/include/boost/range/algorithm/heap_algorithm.hpp

//  Copyright Neil Groves 2009. Use, modification and
//  distribution is subject to the Boost Software License, Version
//  1.0. (See accompanying file LICENSE_1_0.txt or copy at
//  http://www.boost.org/LICENSE_1_0.txt)
//
//
// For more information, see http://www.boost.org/libs/range/
//
#ifndef BOOST_RANGE_ALGORITHM_HEAP_ALGORITHM_HPP_INCLUDED
#define BOOST_RANGE_ALGORITHM_HEAP_ALGORITHM_HPP_INCLUDED

#include <boost/concept_check.hpp>
#include <boost/range/begin.hpp>
#include <boost/range/end.hpp>
#include <boost/range/concepts.hpp>
#include <algorithm>

namespace boost
{
    /// \brief template function push_heap
    ///
    /// range-based version of the push_heap std algorithm
    ///
    /// \pre RandomAccessRange is a model of the RandomAccessRangeConcept
    /// \pre Compare is a model of the BinaryPredicateConcept
    template<class RandomAccessRange>
    inline void push_heap(RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::push_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange>
    inline void push_heap(const RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::push_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void push_heap(RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::push_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void push_heap(const RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::push_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \brief template function pop_heap
    ///
    /// range-based version of the pop_heap std algorithm
    ///
    /// \pre RandomAccessRange is a model of the RandomAccessRangeConcept
    /// \pre Compare is a model of the BinaryPredicateConcept
    template<class RandomAccessRange>
    inline void pop_heap(RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::pop_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange>
    inline void pop_heap(const RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::pop_heap(boost::begin(rng),boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void pop_heap(RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::pop_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void pop_heap(const RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::pop_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \brief template function make_heap
    ///
    /// range-based version of the make_heap std algorithm
    ///
    /// \pre RandomAccessRange is a model of the RandomAccessRangeConcept
    /// \pre Compare is a model of the BinaryPredicateConcept
    template<class RandomAccessRange>
    inline void make_heap(RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::make_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange>
    inline void make_heap(const RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::make_heap(boost::begin(rng),boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void make_heap(RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::make_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void make_heap(const RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::make_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \brief template function sort_heap
    ///
    /// range-based version of the sort_heap std algorithm
    ///
    /// \pre RandomAccessRange is a model of the RandomAccessRangeConcept
    /// \pre Compare is a model of the BinaryPredicateConcept
    template<class RandomAccessRange>
    inline void sort_heap(RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::sort_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange>
    inline void sort_heap(const RandomAccessRange& rng)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::sort_heap(boost::begin(rng), boost::end(rng));
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void sort_heap(RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::sort_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }

    /// \overload
    template<class RandomAccessRange, class Compare>
    inline void sort_heap(const RandomAccessRange& rng, Compare comp_pred)
    {
        boost::function_requires< RandomAccessRangeConcept<RandomAccessRange> >();
        std::sort_heap(boost::begin(rng), boost::end(rng), comp_pred);
    }
}

#endif // include guard