sort.hpp

/*
    Copyright 2013 Adobe
    Distributed under 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)
*/
/**************************************************************************************************/

#ifndef ADOBE_ALGORITHM_SORT_HPP
#define ADOBE_ALGORITHM_SORT_HPP

#include <adobe/config.hpp>

#include <boost/range/begin.hpp>
#include <boost/range/end.hpp>

#include <algorithm>
#include <functional>

/**************************************************************************************************/

namespace adobe {

/**************************************************************************************************/
/*!
\defgroup sort sort
\ingroup sorting

\see
    - [STL documentation for sort](https://www.boost.org/sgi/stl/sort.html)
    - [STL documentation for stable_sort](https://www.boost.org/sgi/stl/stable_sort.html)
    - [STL documentation for partial_sort_copy](https://www.boost.org/sgi/stl/partial_sort_copy.html)
*/
/**************************************************************************************************/
/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessRange>
inline void sort(RandomAccessRange& range) {
    return std::sort(boost::begin(range), boost::end(range));
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessIterator, class Compare>
inline void sort(RandomAccessIterator first, RandomAccessIterator last, Compare comp) {
    return std::sort(first, last, [&comp](const auto& a, const auto& b) {
        return std::invoke(comp, a, b);
    });
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <typename I, // I models RandomAccessIterator
          typename C, // C models StrictWeakOrdering(T, T)
          typename P>
// P models UnaryFunction(value_type(I)) -> T
inline void sort(I f, I l, C c, P p) {
    return std::sort(
        f, l,
        [&p, &c](const auto& a, const auto& b) {
            return std::invoke(c, std::invoke(p, a), std::invoke(p, b));
        });
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <typename R, // I models RandomAccessRange
          typename C, // C models StrictWeakOrdering(T, T)
          typename P>
// P models UnaryFunction(value_type(I)) -> T
inline void sort(R& r, C c, P p) {
    return adobe::sort(boost::begin(r), boost::end(r), c, p);
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessRange, class Compare>
inline void sort(RandomAccessRange& range, Compare comp) {
    return adobe::sort(boost::begin(range), boost::end(range), comp);
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessRange>
inline void stable_sort(RandomAccessRange& range) {
    return std::stable_sort(boost::begin(range), boost::end(range));
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessIterator, class Compare>
inline void stable_sort(RandomAccessIterator first, RandomAccessIterator last, Compare comp) {
    return std::stable_sort(first, last,
        [&comp](const auto& a, const auto& b) {
            return std::invoke(comp, a, b);
        });
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class RandomAccessRange, class Compare>
inline void stable_sort(RandomAccessRange& range, Compare comp) {
    return adobe::stable_sort(boost::begin(range), boost::end(range), comp);
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class InputRange, class RandomAccessRange>
inline void partial_sort_copy(InputRange& range, RandomAccessRange& result_range) {
    return std::partial_sort_copy(boost::begin(range), boost::end(range),
                                  boost::begin(result_range), boost::end(result_range));
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class InputRange, class RandomAccessRange>
inline void partial_sort_copy(const InputRange& range, RandomAccessRange& result_range) {
    return std::partial_sort_copy(boost::begin(range), boost::end(range),
                                  boost::begin(result_range), boost::end(result_range));
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class InputIterator, class RandomAccessIterator, class Compare>
inline void partial_sort_copy(InputIterator first, InputIterator last,
                              RandomAccessIterator result_first, RandomAccessIterator result_last,
                              Compare comp) {
    return std::partial_sort_copy(first, last, result_first, result_last,
        [&comp](const auto& a, const auto& b) {
            return std::invoke(comp, a, b);
        });
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class InputRange, class RandomAccessRange, class Compare>
inline void partial_sort_copy(InputRange& range, RandomAccessRange& result_range, Compare comp) {
    return adobe::partial_sort_copy(boost::begin(range), boost::end(range),
                                    boost::begin(result_range), boost::end(result_range), comp);
}

/*!
    \ingroup sort

    \brief sort implementation
*/
template <class InputRange, class RandomAccessRange, class Compare>
inline void partial_sort_copy(const InputRange& range, RandomAccessRange& result_range,
                              Compare comp) {
    return adobe::partial_sort_copy(boost::begin(range), boost::end(range),
                                    boost::begin(result_range), boost::end(result_range), comp);
}

/**************************************************************************************************/

} // namespace adobe

/**************************************************************************************************/

#endif

/**************************************************************************************************/