3 Forward declares `boost::hana::ordering`.
5 @copyright Louis Dionne 2013-2017
6 Distributed under the Boost Software License, Version 1.0.
7 (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
10 #ifndef BOOST_HANA_FWD_ORDERING_HPP
11 #define BOOST_HANA_FWD_ORDERING_HPP
13 #include <boost/hana/config.hpp>
16 BOOST_HANA_NAMESPACE_BEGIN
17 //! Returns a function performing `less` after applying a transformation
18 //! to both arguments.
19 //! @ingroup group-Orderable
21 //! `ordering` creates a total order based on the result of applying a
22 //! function to some objects, which is especially useful in conjunction
23 //! with algorithms that accept a custom predicate that must represent
26 //! Specifically, `ordering` is such that
28 //! ordering(f) == less ^on^ f
32 //! ordering(f)(x, y) == less(f(x), f(y))
36 //! This is not a tag-dispatched method (hence it can't be customized),
37 //! but just a convenience function provided with the `Orderable` concept.
42 //! Given a Logical `Bool` and an Orderable `B`, the signature is
43 //! @f$ \mathrm{ordering} : (A \to B) \to (A \times A \to Bool) @f$.
48 //! @include example/ordering.cpp
49 #ifdef BOOST_HANA_DOXYGEN_INVOKED
50 constexpr auto ordering = [](auto&& f) {
51 return [perfect-capture](auto&& x, auto&& y) -> decltype(auto) {
52 return less(f(forwarded(x)), f(forwarded(y)));
58 constexpr auto operator()(F&& f) const;
61 constexpr ordering_t ordering{};
63 BOOST_HANA_NAMESPACE_END
65 #endif // !BOOST_HANA_FWD_ORDERING_HPP