10b57cec5SDimitry Andric //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric // 90b57cec5SDimitry Andric // This file contains some templates that are useful if you are working with the 100b57cec5SDimitry Andric // STL at all. 110b57cec5SDimitry Andric // 120b57cec5SDimitry Andric // No library is required when using these functions. 130b57cec5SDimitry Andric // 140b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 150b57cec5SDimitry Andric 160b57cec5SDimitry Andric #ifndef LLVM_ADT_STLEXTRAS_H 170b57cec5SDimitry Andric #define LLVM_ADT_STLEXTRAS_H 180b57cec5SDimitry Andric 190b57cec5SDimitry Andric #include "llvm/ADT/Optional.h" 20fe6060f1SDimitry Andric #include "llvm/ADT/STLForwardCompat.h" 210b57cec5SDimitry Andric #include "llvm/ADT/iterator.h" 220b57cec5SDimitry Andric #include "llvm/ADT/iterator_range.h" 230b57cec5SDimitry Andric #include "llvm/Config/abi-breaking.h" 240b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h" 250b57cec5SDimitry Andric #include <algorithm> 260b57cec5SDimitry Andric #include <cassert> 270b57cec5SDimitry Andric #include <cstddef> 280b57cec5SDimitry Andric #include <cstdint> 290b57cec5SDimitry Andric #include <cstdlib> 300b57cec5SDimitry Andric #include <functional> 310b57cec5SDimitry Andric #include <initializer_list> 320b57cec5SDimitry Andric #include <iterator> 330b57cec5SDimitry Andric #include <limits> 340b57cec5SDimitry Andric #include <memory> 350b57cec5SDimitry Andric #include <tuple> 360b57cec5SDimitry Andric #include <type_traits> 370b57cec5SDimitry Andric #include <utility> 380b57cec5SDimitry Andric 390b57cec5SDimitry Andric #ifdef EXPENSIVE_CHECKS 400b57cec5SDimitry Andric #include <random> // for std::mt19937 410b57cec5SDimitry Andric #endif 420b57cec5SDimitry Andric 430b57cec5SDimitry Andric namespace llvm { 440b57cec5SDimitry Andric 450b57cec5SDimitry Andric // Only used by compiler if both template types are the same. Useful when 460b57cec5SDimitry Andric // using SFINAE to test for the existence of member functions. 470b57cec5SDimitry Andric template <typename T, T> struct SameType; 480b57cec5SDimitry Andric 490b57cec5SDimitry Andric namespace detail { 500b57cec5SDimitry Andric 510b57cec5SDimitry Andric template <typename RangeT> 520b57cec5SDimitry Andric using IterOfRange = decltype(std::begin(std::declval<RangeT &>())); 530b57cec5SDimitry Andric 545ffd83dbSDimitry Andric template <typename RangeT> 555ffd83dbSDimitry Andric using ValueOfRange = typename std::remove_reference<decltype( 565ffd83dbSDimitry Andric *std::begin(std::declval<RangeT &>()))>::type; 575ffd83dbSDimitry Andric 580b57cec5SDimitry Andric } // end namespace detail 590b57cec5SDimitry Andric 600b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 610b57cec5SDimitry Andric // Extra additions to <type_traits> 620b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 630b57cec5SDimitry Andric 640b57cec5SDimitry Andric template <typename T> struct make_const_ptr { 650b57cec5SDimitry Andric using type = 660b57cec5SDimitry Andric typename std::add_pointer<typename std::add_const<T>::type>::type; 670b57cec5SDimitry Andric }; 680b57cec5SDimitry Andric 690b57cec5SDimitry Andric template <typename T> struct make_const_ref { 700b57cec5SDimitry Andric using type = typename std::add_lvalue_reference< 710b57cec5SDimitry Andric typename std::add_const<T>::type>::type; 720b57cec5SDimitry Andric }; 730b57cec5SDimitry Andric 745ffd83dbSDimitry Andric namespace detail { 755ffd83dbSDimitry Andric template <typename...> using void_t = void; 765ffd83dbSDimitry Andric template <class, template <class...> class Op, class... Args> struct detector { 775ffd83dbSDimitry Andric using value_t = std::false_type; 785ffd83dbSDimitry Andric }; 795ffd83dbSDimitry Andric template <template <class...> class Op, class... Args> 805ffd83dbSDimitry Andric struct detector<void_t<Op<Args...>>, Op, Args...> { 815ffd83dbSDimitry Andric using value_t = std::true_type; 825ffd83dbSDimitry Andric }; 835ffd83dbSDimitry Andric } // end namespace detail 845ffd83dbSDimitry Andric 85fe6060f1SDimitry Andric /// Detects if a given trait holds for some set of arguments 'Args'. 86fe6060f1SDimitry Andric /// For example, the given trait could be used to detect if a given type 87fe6060f1SDimitry Andric /// has a copy assignment operator: 88fe6060f1SDimitry Andric /// template<class T> 89fe6060f1SDimitry Andric /// using has_copy_assign_t = decltype(std::declval<T&>() 90fe6060f1SDimitry Andric /// = std::declval<const T&>()); 91fe6060f1SDimitry Andric /// bool fooHasCopyAssign = is_detected<has_copy_assign_t, FooClass>::value; 925ffd83dbSDimitry Andric template <template <class...> class Op, class... Args> 935ffd83dbSDimitry Andric using is_detected = typename detail::detector<void, Op, Args...>::value_t; 945ffd83dbSDimitry Andric 955ffd83dbSDimitry Andric namespace detail { 965ffd83dbSDimitry Andric template <typename Callable, typename... Args> 975ffd83dbSDimitry Andric using is_invocable = 985ffd83dbSDimitry Andric decltype(std::declval<Callable &>()(std::declval<Args>()...)); 995ffd83dbSDimitry Andric } // namespace detail 1005ffd83dbSDimitry Andric 101fe6060f1SDimitry Andric /// Check if a Callable type can be invoked with the given set of arg types. 1025ffd83dbSDimitry Andric template <typename Callable, typename... Args> 1035ffd83dbSDimitry Andric using is_invocable = is_detected<detail::is_invocable, Callable, Args...>; 1045ffd83dbSDimitry Andric 1055ffd83dbSDimitry Andric /// This class provides various trait information about a callable object. 1065ffd83dbSDimitry Andric /// * To access the number of arguments: Traits::num_args 1075ffd83dbSDimitry Andric /// * To access the type of an argument: Traits::arg_t<Index> 1085ffd83dbSDimitry Andric /// * To access the type of the result: Traits::result_t 1095ffd83dbSDimitry Andric template <typename T, bool isClass = std::is_class<T>::value> 1105ffd83dbSDimitry Andric struct function_traits : public function_traits<decltype(&T::operator())> {}; 1115ffd83dbSDimitry Andric 1125ffd83dbSDimitry Andric /// Overload for class function types. 1135ffd83dbSDimitry Andric template <typename ClassType, typename ReturnType, typename... Args> 1145ffd83dbSDimitry Andric struct function_traits<ReturnType (ClassType::*)(Args...) const, false> { 1155ffd83dbSDimitry Andric /// The number of arguments to this function. 1165ffd83dbSDimitry Andric enum { num_args = sizeof...(Args) }; 1175ffd83dbSDimitry Andric 1185ffd83dbSDimitry Andric /// The result type of this function. 1195ffd83dbSDimitry Andric using result_t = ReturnType; 1205ffd83dbSDimitry Andric 1215ffd83dbSDimitry Andric /// The type of an argument to this function. 1225ffd83dbSDimitry Andric template <size_t Index> 1235ffd83dbSDimitry Andric using arg_t = typename std::tuple_element<Index, std::tuple<Args...>>::type; 1245ffd83dbSDimitry Andric }; 1255ffd83dbSDimitry Andric /// Overload for class function types. 1265ffd83dbSDimitry Andric template <typename ClassType, typename ReturnType, typename... Args> 1275ffd83dbSDimitry Andric struct function_traits<ReturnType (ClassType::*)(Args...), false> 1285ffd83dbSDimitry Andric : function_traits<ReturnType (ClassType::*)(Args...) const> {}; 1295ffd83dbSDimitry Andric /// Overload for non-class function types. 1305ffd83dbSDimitry Andric template <typename ReturnType, typename... Args> 1315ffd83dbSDimitry Andric struct function_traits<ReturnType (*)(Args...), false> { 1325ffd83dbSDimitry Andric /// The number of arguments to this function. 1335ffd83dbSDimitry Andric enum { num_args = sizeof...(Args) }; 1345ffd83dbSDimitry Andric 1355ffd83dbSDimitry Andric /// The result type of this function. 1365ffd83dbSDimitry Andric using result_t = ReturnType; 1375ffd83dbSDimitry Andric 1385ffd83dbSDimitry Andric /// The type of an argument to this function. 1395ffd83dbSDimitry Andric template <size_t i> 1405ffd83dbSDimitry Andric using arg_t = typename std::tuple_element<i, std::tuple<Args...>>::type; 1415ffd83dbSDimitry Andric }; 1425ffd83dbSDimitry Andric /// Overload for non-class function type references. 1435ffd83dbSDimitry Andric template <typename ReturnType, typename... Args> 1445ffd83dbSDimitry Andric struct function_traits<ReturnType (&)(Args...), false> 1455ffd83dbSDimitry Andric : public function_traits<ReturnType (*)(Args...)> {}; 1465ffd83dbSDimitry Andric 1470b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 1480b57cec5SDimitry Andric // Extra additions to <functional> 1490b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 1500b57cec5SDimitry Andric 1510b57cec5SDimitry Andric template <class Ty> struct identity { 1520b57cec5SDimitry Andric using argument_type = Ty; 1530b57cec5SDimitry Andric 1540b57cec5SDimitry Andric Ty &operator()(Ty &self) const { 1550b57cec5SDimitry Andric return self; 1560b57cec5SDimitry Andric } 1570b57cec5SDimitry Andric const Ty &operator()(const Ty &self) const { 1580b57cec5SDimitry Andric return self; 1590b57cec5SDimitry Andric } 1600b57cec5SDimitry Andric }; 1610b57cec5SDimitry Andric 1620b57cec5SDimitry Andric /// An efficient, type-erasing, non-owning reference to a callable. This is 1630b57cec5SDimitry Andric /// intended for use as the type of a function parameter that is not used 1640b57cec5SDimitry Andric /// after the function in question returns. 1650b57cec5SDimitry Andric /// 1660b57cec5SDimitry Andric /// This class does not own the callable, so it is not in general safe to store 1670b57cec5SDimitry Andric /// a function_ref. 1680b57cec5SDimitry Andric template<typename Fn> class function_ref; 1690b57cec5SDimitry Andric 1700b57cec5SDimitry Andric template<typename Ret, typename ...Params> 1710b57cec5SDimitry Andric class function_ref<Ret(Params...)> { 1720b57cec5SDimitry Andric Ret (*callback)(intptr_t callable, Params ...params) = nullptr; 1730b57cec5SDimitry Andric intptr_t callable; 1740b57cec5SDimitry Andric 1750b57cec5SDimitry Andric template<typename Callable> 1760b57cec5SDimitry Andric static Ret callback_fn(intptr_t callable, Params ...params) { 1770b57cec5SDimitry Andric return (*reinterpret_cast<Callable*>(callable))( 1780b57cec5SDimitry Andric std::forward<Params>(params)...); 1790b57cec5SDimitry Andric } 1800b57cec5SDimitry Andric 1810b57cec5SDimitry Andric public: 1820b57cec5SDimitry Andric function_ref() = default; 1830b57cec5SDimitry Andric function_ref(std::nullptr_t) {} 1840b57cec5SDimitry Andric 1850b57cec5SDimitry Andric template <typename Callable> 1865ffd83dbSDimitry Andric function_ref( 1875ffd83dbSDimitry Andric Callable &&callable, 188e8d8bef9SDimitry Andric // This is not the copy-constructor. 189fe6060f1SDimitry Andric std::enable_if_t<!std::is_same<remove_cvref_t<Callable>, 190e8d8bef9SDimitry Andric function_ref>::value> * = nullptr, 191e8d8bef9SDimitry Andric // Functor must be callable and return a suitable type. 192e8d8bef9SDimitry Andric std::enable_if_t<std::is_void<Ret>::value || 193e8d8bef9SDimitry Andric std::is_convertible<decltype(std::declval<Callable>()( 194e8d8bef9SDimitry Andric std::declval<Params>()...)), 195e8d8bef9SDimitry Andric Ret>::value> * = nullptr) 1960b57cec5SDimitry Andric : callback(callback_fn<typename std::remove_reference<Callable>::type>), 1970b57cec5SDimitry Andric callable(reinterpret_cast<intptr_t>(&callable)) {} 1980b57cec5SDimitry Andric 1990b57cec5SDimitry Andric Ret operator()(Params ...params) const { 2000b57cec5SDimitry Andric return callback(callable, std::forward<Params>(params)...); 2010b57cec5SDimitry Andric } 2020b57cec5SDimitry Andric 2035ffd83dbSDimitry Andric explicit operator bool() const { return callback; } 2040b57cec5SDimitry Andric }; 2050b57cec5SDimitry Andric 2060b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 2070b57cec5SDimitry Andric // Extra additions to <iterator> 2080b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 2090b57cec5SDimitry Andric 2100b57cec5SDimitry Andric namespace adl_detail { 2110b57cec5SDimitry Andric 2120b57cec5SDimitry Andric using std::begin; 2130b57cec5SDimitry Andric 2140b57cec5SDimitry Andric template <typename ContainerTy> 2155ffd83dbSDimitry Andric decltype(auto) adl_begin(ContainerTy &&container) { 2160b57cec5SDimitry Andric return begin(std::forward<ContainerTy>(container)); 2170b57cec5SDimitry Andric } 2180b57cec5SDimitry Andric 2190b57cec5SDimitry Andric using std::end; 2200b57cec5SDimitry Andric 2210b57cec5SDimitry Andric template <typename ContainerTy> 2225ffd83dbSDimitry Andric decltype(auto) adl_end(ContainerTy &&container) { 2230b57cec5SDimitry Andric return end(std::forward<ContainerTy>(container)); 2240b57cec5SDimitry Andric } 2250b57cec5SDimitry Andric 2260b57cec5SDimitry Andric using std::swap; 2270b57cec5SDimitry Andric 2280b57cec5SDimitry Andric template <typename T> 2290b57cec5SDimitry Andric void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(), 2300b57cec5SDimitry Andric std::declval<T>()))) { 2310b57cec5SDimitry Andric swap(std::forward<T>(lhs), std::forward<T>(rhs)); 2320b57cec5SDimitry Andric } 2330b57cec5SDimitry Andric 2340b57cec5SDimitry Andric } // end namespace adl_detail 2350b57cec5SDimitry Andric 2360b57cec5SDimitry Andric template <typename ContainerTy> 2375ffd83dbSDimitry Andric decltype(auto) adl_begin(ContainerTy &&container) { 2380b57cec5SDimitry Andric return adl_detail::adl_begin(std::forward<ContainerTy>(container)); 2390b57cec5SDimitry Andric } 2400b57cec5SDimitry Andric 2410b57cec5SDimitry Andric template <typename ContainerTy> 2425ffd83dbSDimitry Andric decltype(auto) adl_end(ContainerTy &&container) { 2430b57cec5SDimitry Andric return adl_detail::adl_end(std::forward<ContainerTy>(container)); 2440b57cec5SDimitry Andric } 2450b57cec5SDimitry Andric 2460b57cec5SDimitry Andric template <typename T> 2470b57cec5SDimitry Andric void adl_swap(T &&lhs, T &&rhs) noexcept( 2480b57cec5SDimitry Andric noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) { 2490b57cec5SDimitry Andric adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs)); 2500b57cec5SDimitry Andric } 2510b57cec5SDimitry Andric 2520b57cec5SDimitry Andric /// Test whether \p RangeOrContainer is empty. Similar to C++17 std::empty. 2530b57cec5SDimitry Andric template <typename T> 2540b57cec5SDimitry Andric constexpr bool empty(const T &RangeOrContainer) { 2550b57cec5SDimitry Andric return adl_begin(RangeOrContainer) == adl_end(RangeOrContainer); 2560b57cec5SDimitry Andric } 2570b57cec5SDimitry Andric 2585ffd83dbSDimitry Andric /// Returns true if the given container only contains a single element. 2595ffd83dbSDimitry Andric template <typename ContainerTy> bool hasSingleElement(ContainerTy &&C) { 2605ffd83dbSDimitry Andric auto B = std::begin(C), E = std::end(C); 2615ffd83dbSDimitry Andric return B != E && std::next(B) == E; 2625ffd83dbSDimitry Andric } 2635ffd83dbSDimitry Andric 264480093f4SDimitry Andric /// Return a range covering \p RangeOrContainer with the first N elements 265480093f4SDimitry Andric /// excluded. 266e8d8bef9SDimitry Andric template <typename T> auto drop_begin(T &&RangeOrContainer, size_t N = 1) { 267480093f4SDimitry Andric return make_range(std::next(adl_begin(RangeOrContainer), N), 268480093f4SDimitry Andric adl_end(RangeOrContainer)); 269480093f4SDimitry Andric } 270480093f4SDimitry Andric 2710b57cec5SDimitry Andric // mapped_iterator - This is a simple iterator adapter that causes a function to 2720b57cec5SDimitry Andric // be applied whenever operator* is invoked on the iterator. 2730b57cec5SDimitry Andric 2740b57cec5SDimitry Andric template <typename ItTy, typename FuncTy, 275*349cc55cSDimitry Andric typename ReferenceTy = 2760b57cec5SDimitry Andric decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))> 2770b57cec5SDimitry Andric class mapped_iterator 2780b57cec5SDimitry Andric : public iterator_adaptor_base< 2790b57cec5SDimitry Andric mapped_iterator<ItTy, FuncTy>, ItTy, 2800b57cec5SDimitry Andric typename std::iterator_traits<ItTy>::iterator_category, 281*349cc55cSDimitry Andric std::remove_reference_t<ReferenceTy>, 282*349cc55cSDimitry Andric typename std::iterator_traits<ItTy>::difference_type, 283*349cc55cSDimitry Andric std::remove_reference_t<ReferenceTy> *, ReferenceTy> { 2840b57cec5SDimitry Andric public: 2850b57cec5SDimitry Andric mapped_iterator(ItTy U, FuncTy F) 2860b57cec5SDimitry Andric : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {} 2870b57cec5SDimitry Andric 2880b57cec5SDimitry Andric ItTy getCurrent() { return this->I; } 2890b57cec5SDimitry Andric 290*349cc55cSDimitry Andric const FuncTy &getFunction() const { return F; } 291*349cc55cSDimitry Andric 292*349cc55cSDimitry Andric ReferenceTy operator*() const { return F(*this->I); } 2930b57cec5SDimitry Andric 2940b57cec5SDimitry Andric private: 2950b57cec5SDimitry Andric FuncTy F; 2960b57cec5SDimitry Andric }; 2970b57cec5SDimitry Andric 2980b57cec5SDimitry Andric // map_iterator - Provide a convenient way to create mapped_iterators, just like 2990b57cec5SDimitry Andric // make_pair is useful for creating pairs... 3000b57cec5SDimitry Andric template <class ItTy, class FuncTy> 3010b57cec5SDimitry Andric inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) { 3020b57cec5SDimitry Andric return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F)); 3030b57cec5SDimitry Andric } 3040b57cec5SDimitry Andric 3050b57cec5SDimitry Andric template <class ContainerTy, class FuncTy> 3065ffd83dbSDimitry Andric auto map_range(ContainerTy &&C, FuncTy F) { 3070b57cec5SDimitry Andric return make_range(map_iterator(C.begin(), F), map_iterator(C.end(), F)); 3080b57cec5SDimitry Andric } 3090b57cec5SDimitry Andric 310*349cc55cSDimitry Andric /// A base type of mapped iterator, that is useful for building derived 311*349cc55cSDimitry Andric /// iterators that do not need/want to store the map function (as in 312*349cc55cSDimitry Andric /// mapped_iterator). These iterators must simply provide a `mapElement` method 313*349cc55cSDimitry Andric /// that defines how to map a value of the iterator to the provided reference 314*349cc55cSDimitry Andric /// type. 315*349cc55cSDimitry Andric template <typename DerivedT, typename ItTy, typename ReferenceTy> 316*349cc55cSDimitry Andric class mapped_iterator_base 317*349cc55cSDimitry Andric : public iterator_adaptor_base< 318*349cc55cSDimitry Andric DerivedT, ItTy, 319*349cc55cSDimitry Andric typename std::iterator_traits<ItTy>::iterator_category, 320*349cc55cSDimitry Andric std::remove_reference_t<ReferenceTy>, 321*349cc55cSDimitry Andric typename std::iterator_traits<ItTy>::difference_type, 322*349cc55cSDimitry Andric std::remove_reference_t<ReferenceTy> *, ReferenceTy> { 323*349cc55cSDimitry Andric public: 324*349cc55cSDimitry Andric using BaseT = mapped_iterator_base; 325*349cc55cSDimitry Andric 326*349cc55cSDimitry Andric mapped_iterator_base(ItTy U) 327*349cc55cSDimitry Andric : mapped_iterator_base::iterator_adaptor_base(std::move(U)) {} 328*349cc55cSDimitry Andric 329*349cc55cSDimitry Andric ItTy getCurrent() { return this->I; } 330*349cc55cSDimitry Andric 331*349cc55cSDimitry Andric ReferenceTy operator*() const { 332*349cc55cSDimitry Andric return static_cast<const DerivedT &>(*this).mapElement(*this->I); 333*349cc55cSDimitry Andric } 334*349cc55cSDimitry Andric }; 335*349cc55cSDimitry Andric 3360b57cec5SDimitry Andric /// Helper to determine if type T has a member called rbegin(). 3370b57cec5SDimitry Andric template <typename Ty> class has_rbegin_impl { 3380b57cec5SDimitry Andric using yes = char[1]; 3390b57cec5SDimitry Andric using no = char[2]; 3400b57cec5SDimitry Andric 3410b57cec5SDimitry Andric template <typename Inner> 3420b57cec5SDimitry Andric static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr); 3430b57cec5SDimitry Andric 3440b57cec5SDimitry Andric template <typename> 3450b57cec5SDimitry Andric static no& test(...); 3460b57cec5SDimitry Andric 3470b57cec5SDimitry Andric public: 3480b57cec5SDimitry Andric static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes); 3490b57cec5SDimitry Andric }; 3500b57cec5SDimitry Andric 3510b57cec5SDimitry Andric /// Metafunction to determine if T& or T has a member called rbegin(). 3520b57cec5SDimitry Andric template <typename Ty> 3530b57cec5SDimitry Andric struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> { 3540b57cec5SDimitry Andric }; 3550b57cec5SDimitry Andric 3560b57cec5SDimitry Andric // Returns an iterator_range over the given container which iterates in reverse. 3570b57cec5SDimitry Andric // Note that the container must have rbegin()/rend() methods for this to work. 3580b57cec5SDimitry Andric template <typename ContainerTy> 3590b57cec5SDimitry Andric auto reverse(ContainerTy &&C, 3605ffd83dbSDimitry Andric std::enable_if_t<has_rbegin<ContainerTy>::value> * = nullptr) { 3610b57cec5SDimitry Andric return make_range(C.rbegin(), C.rend()); 3620b57cec5SDimitry Andric } 3630b57cec5SDimitry Andric 3640b57cec5SDimitry Andric // Returns a std::reverse_iterator wrapped around the given iterator. 3650b57cec5SDimitry Andric template <typename IteratorTy> 3660b57cec5SDimitry Andric std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) { 3670b57cec5SDimitry Andric return std::reverse_iterator<IteratorTy>(It); 3680b57cec5SDimitry Andric } 3690b57cec5SDimitry Andric 3700b57cec5SDimitry Andric // Returns an iterator_range over the given container which iterates in reverse. 3710b57cec5SDimitry Andric // Note that the container must have begin()/end() methods which return 3720b57cec5SDimitry Andric // bidirectional iterators for this to work. 3730b57cec5SDimitry Andric template <typename ContainerTy> 3745ffd83dbSDimitry Andric auto reverse(ContainerTy &&C, 3755ffd83dbSDimitry Andric std::enable_if_t<!has_rbegin<ContainerTy>::value> * = nullptr) { 3760b57cec5SDimitry Andric return make_range(llvm::make_reverse_iterator(std::end(C)), 3770b57cec5SDimitry Andric llvm::make_reverse_iterator(std::begin(C))); 3780b57cec5SDimitry Andric } 3790b57cec5SDimitry Andric 3800b57cec5SDimitry Andric /// An iterator adaptor that filters the elements of given inner iterators. 3810b57cec5SDimitry Andric /// 3820b57cec5SDimitry Andric /// The predicate parameter should be a callable object that accepts the wrapped 3830b57cec5SDimitry Andric /// iterator's reference type and returns a bool. When incrementing or 3840b57cec5SDimitry Andric /// decrementing the iterator, it will call the predicate on each element and 3850b57cec5SDimitry Andric /// skip any where it returns false. 3860b57cec5SDimitry Andric /// 3870b57cec5SDimitry Andric /// \code 3880b57cec5SDimitry Andric /// int A[] = { 1, 2, 3, 4 }; 3890b57cec5SDimitry Andric /// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; }); 3900b57cec5SDimitry Andric /// // R contains { 1, 3 }. 3910b57cec5SDimitry Andric /// \endcode 3920b57cec5SDimitry Andric /// 3930b57cec5SDimitry Andric /// Note: filter_iterator_base implements support for forward iteration. 3940b57cec5SDimitry Andric /// filter_iterator_impl exists to provide support for bidirectional iteration, 3950b57cec5SDimitry Andric /// conditional on whether the wrapped iterator supports it. 3960b57cec5SDimitry Andric template <typename WrappedIteratorT, typename PredicateT, typename IterTag> 3970b57cec5SDimitry Andric class filter_iterator_base 3980b57cec5SDimitry Andric : public iterator_adaptor_base< 3990b57cec5SDimitry Andric filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, 4000b57cec5SDimitry Andric WrappedIteratorT, 4010b57cec5SDimitry Andric typename std::common_type< 4020b57cec5SDimitry Andric IterTag, typename std::iterator_traits< 4030b57cec5SDimitry Andric WrappedIteratorT>::iterator_category>::type> { 404*349cc55cSDimitry Andric using BaseT = typename filter_iterator_base::iterator_adaptor_base; 4050b57cec5SDimitry Andric 4060b57cec5SDimitry Andric protected: 4070b57cec5SDimitry Andric WrappedIteratorT End; 4080b57cec5SDimitry Andric PredicateT Pred; 4090b57cec5SDimitry Andric 4100b57cec5SDimitry Andric void findNextValid() { 4110b57cec5SDimitry Andric while (this->I != End && !Pred(*this->I)) 4120b57cec5SDimitry Andric BaseT::operator++(); 4130b57cec5SDimitry Andric } 4140b57cec5SDimitry Andric 4150b57cec5SDimitry Andric // Construct the iterator. The begin iterator needs to know where the end 4160b57cec5SDimitry Andric // is, so that it can properly stop when it gets there. The end iterator only 4170b57cec5SDimitry Andric // needs the predicate to support bidirectional iteration. 4180b57cec5SDimitry Andric filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End, 4190b57cec5SDimitry Andric PredicateT Pred) 4200b57cec5SDimitry Andric : BaseT(Begin), End(End), Pred(Pred) { 4210b57cec5SDimitry Andric findNextValid(); 4220b57cec5SDimitry Andric } 4230b57cec5SDimitry Andric 4240b57cec5SDimitry Andric public: 4250b57cec5SDimitry Andric using BaseT::operator++; 4260b57cec5SDimitry Andric 4270b57cec5SDimitry Andric filter_iterator_base &operator++() { 4280b57cec5SDimitry Andric BaseT::operator++(); 4290b57cec5SDimitry Andric findNextValid(); 4300b57cec5SDimitry Andric return *this; 4310b57cec5SDimitry Andric } 4320b57cec5SDimitry Andric }; 4330b57cec5SDimitry Andric 4340b57cec5SDimitry Andric /// Specialization of filter_iterator_base for forward iteration only. 4350b57cec5SDimitry Andric template <typename WrappedIteratorT, typename PredicateT, 4360b57cec5SDimitry Andric typename IterTag = std::forward_iterator_tag> 4370b57cec5SDimitry Andric class filter_iterator_impl 4380b57cec5SDimitry Andric : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> { 4390b57cec5SDimitry Andric public: 4400b57cec5SDimitry Andric filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, 4410b57cec5SDimitry Andric PredicateT Pred) 442*349cc55cSDimitry Andric : filter_iterator_impl::filter_iterator_base(Begin, End, Pred) {} 4430b57cec5SDimitry Andric }; 4440b57cec5SDimitry Andric 4450b57cec5SDimitry Andric /// Specialization of filter_iterator_base for bidirectional iteration. 4460b57cec5SDimitry Andric template <typename WrappedIteratorT, typename PredicateT> 4470b57cec5SDimitry Andric class filter_iterator_impl<WrappedIteratorT, PredicateT, 4480b57cec5SDimitry Andric std::bidirectional_iterator_tag> 4490b57cec5SDimitry Andric : public filter_iterator_base<WrappedIteratorT, PredicateT, 4500b57cec5SDimitry Andric std::bidirectional_iterator_tag> { 451*349cc55cSDimitry Andric using BaseT = typename filter_iterator_impl::filter_iterator_base; 452*349cc55cSDimitry Andric 4530b57cec5SDimitry Andric void findPrevValid() { 4540b57cec5SDimitry Andric while (!this->Pred(*this->I)) 4550b57cec5SDimitry Andric BaseT::operator--(); 4560b57cec5SDimitry Andric } 4570b57cec5SDimitry Andric 4580b57cec5SDimitry Andric public: 4590b57cec5SDimitry Andric using BaseT::operator--; 4600b57cec5SDimitry Andric 4610b57cec5SDimitry Andric filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, 4620b57cec5SDimitry Andric PredicateT Pred) 4630b57cec5SDimitry Andric : BaseT(Begin, End, Pred) {} 4640b57cec5SDimitry Andric 4650b57cec5SDimitry Andric filter_iterator_impl &operator--() { 4660b57cec5SDimitry Andric BaseT::operator--(); 4670b57cec5SDimitry Andric findPrevValid(); 4680b57cec5SDimitry Andric return *this; 4690b57cec5SDimitry Andric } 4700b57cec5SDimitry Andric }; 4710b57cec5SDimitry Andric 4720b57cec5SDimitry Andric namespace detail { 4730b57cec5SDimitry Andric 4740b57cec5SDimitry Andric template <bool is_bidirectional> struct fwd_or_bidi_tag_impl { 4750b57cec5SDimitry Andric using type = std::forward_iterator_tag; 4760b57cec5SDimitry Andric }; 4770b57cec5SDimitry Andric 4780b57cec5SDimitry Andric template <> struct fwd_or_bidi_tag_impl<true> { 4790b57cec5SDimitry Andric using type = std::bidirectional_iterator_tag; 4800b57cec5SDimitry Andric }; 4810b57cec5SDimitry Andric 4820b57cec5SDimitry Andric /// Helper which sets its type member to forward_iterator_tag if the category 4830b57cec5SDimitry Andric /// of \p IterT does not derive from bidirectional_iterator_tag, and to 4840b57cec5SDimitry Andric /// bidirectional_iterator_tag otherwise. 4850b57cec5SDimitry Andric template <typename IterT> struct fwd_or_bidi_tag { 4860b57cec5SDimitry Andric using type = typename fwd_or_bidi_tag_impl<std::is_base_of< 4870b57cec5SDimitry Andric std::bidirectional_iterator_tag, 4880b57cec5SDimitry Andric typename std::iterator_traits<IterT>::iterator_category>::value>::type; 4890b57cec5SDimitry Andric }; 4900b57cec5SDimitry Andric 4910b57cec5SDimitry Andric } // namespace detail 4920b57cec5SDimitry Andric 4930b57cec5SDimitry Andric /// Defines filter_iterator to a suitable specialization of 4940b57cec5SDimitry Andric /// filter_iterator_impl, based on the underlying iterator's category. 4950b57cec5SDimitry Andric template <typename WrappedIteratorT, typename PredicateT> 4960b57cec5SDimitry Andric using filter_iterator = filter_iterator_impl< 4970b57cec5SDimitry Andric WrappedIteratorT, PredicateT, 4980b57cec5SDimitry Andric typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>; 4990b57cec5SDimitry Andric 5000b57cec5SDimitry Andric /// Convenience function that takes a range of elements and a predicate, 5010b57cec5SDimitry Andric /// and return a new filter_iterator range. 5020b57cec5SDimitry Andric /// 5030b57cec5SDimitry Andric /// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the 5040b57cec5SDimitry Andric /// lifetime of that temporary is not kept by the returned range object, and the 5050b57cec5SDimitry Andric /// temporary is going to be dropped on the floor after the make_iterator_range 5060b57cec5SDimitry Andric /// full expression that contains this function call. 5070b57cec5SDimitry Andric template <typename RangeT, typename PredicateT> 5080b57cec5SDimitry Andric iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>> 5090b57cec5SDimitry Andric make_filter_range(RangeT &&Range, PredicateT Pred) { 5100b57cec5SDimitry Andric using FilterIteratorT = 5110b57cec5SDimitry Andric filter_iterator<detail::IterOfRange<RangeT>, PredicateT>; 5120b57cec5SDimitry Andric return make_range( 5130b57cec5SDimitry Andric FilterIteratorT(std::begin(std::forward<RangeT>(Range)), 5140b57cec5SDimitry Andric std::end(std::forward<RangeT>(Range)), Pred), 5150b57cec5SDimitry Andric FilterIteratorT(std::end(std::forward<RangeT>(Range)), 5160b57cec5SDimitry Andric std::end(std::forward<RangeT>(Range)), Pred)); 5170b57cec5SDimitry Andric } 5180b57cec5SDimitry Andric 5190b57cec5SDimitry Andric /// A pseudo-iterator adaptor that is designed to implement "early increment" 5200b57cec5SDimitry Andric /// style loops. 5210b57cec5SDimitry Andric /// 5220b57cec5SDimitry Andric /// This is *not a normal iterator* and should almost never be used directly. It 5230b57cec5SDimitry Andric /// is intended primarily to be used with range based for loops and some range 5240b57cec5SDimitry Andric /// algorithms. 5250b57cec5SDimitry Andric /// 5260b57cec5SDimitry Andric /// The iterator isn't quite an `OutputIterator` or an `InputIterator` but 5270b57cec5SDimitry Andric /// somewhere between them. The constraints of these iterators are: 5280b57cec5SDimitry Andric /// 5290b57cec5SDimitry Andric /// - On construction or after being incremented, it is comparable and 5300b57cec5SDimitry Andric /// dereferencable. It is *not* incrementable. 5310b57cec5SDimitry Andric /// - After being dereferenced, it is neither comparable nor dereferencable, it 5320b57cec5SDimitry Andric /// is only incrementable. 5330b57cec5SDimitry Andric /// 5340b57cec5SDimitry Andric /// This means you can only dereference the iterator once, and you can only 5350b57cec5SDimitry Andric /// increment it once between dereferences. 5360b57cec5SDimitry Andric template <typename WrappedIteratorT> 5370b57cec5SDimitry Andric class early_inc_iterator_impl 5380b57cec5SDimitry Andric : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, 5390b57cec5SDimitry Andric WrappedIteratorT, std::input_iterator_tag> { 540*349cc55cSDimitry Andric using BaseT = typename early_inc_iterator_impl::iterator_adaptor_base; 5410b57cec5SDimitry Andric 5420b57cec5SDimitry Andric using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer; 5430b57cec5SDimitry Andric 5440b57cec5SDimitry Andric protected: 5450b57cec5SDimitry Andric #if LLVM_ENABLE_ABI_BREAKING_CHECKS 5460b57cec5SDimitry Andric bool IsEarlyIncremented = false; 5470b57cec5SDimitry Andric #endif 5480b57cec5SDimitry Andric 5490b57cec5SDimitry Andric public: 5500b57cec5SDimitry Andric early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {} 5510b57cec5SDimitry Andric 5520b57cec5SDimitry Andric using BaseT::operator*; 553e8d8bef9SDimitry Andric decltype(*std::declval<WrappedIteratorT>()) operator*() { 5540b57cec5SDimitry Andric #if LLVM_ENABLE_ABI_BREAKING_CHECKS 5550b57cec5SDimitry Andric assert(!IsEarlyIncremented && "Cannot dereference twice!"); 5560b57cec5SDimitry Andric IsEarlyIncremented = true; 5570b57cec5SDimitry Andric #endif 5580b57cec5SDimitry Andric return *(this->I)++; 5590b57cec5SDimitry Andric } 5600b57cec5SDimitry Andric 5610b57cec5SDimitry Andric using BaseT::operator++; 5620b57cec5SDimitry Andric early_inc_iterator_impl &operator++() { 5630b57cec5SDimitry Andric #if LLVM_ENABLE_ABI_BREAKING_CHECKS 5640b57cec5SDimitry Andric assert(IsEarlyIncremented && "Cannot increment before dereferencing!"); 5650b57cec5SDimitry Andric IsEarlyIncremented = false; 5660b57cec5SDimitry Andric #endif 5670b57cec5SDimitry Andric return *this; 5680b57cec5SDimitry Andric } 5690b57cec5SDimitry Andric 570e8d8bef9SDimitry Andric friend bool operator==(const early_inc_iterator_impl &LHS, 571e8d8bef9SDimitry Andric const early_inc_iterator_impl &RHS) { 5720b57cec5SDimitry Andric #if LLVM_ENABLE_ABI_BREAKING_CHECKS 573e8d8bef9SDimitry Andric assert(!LHS.IsEarlyIncremented && "Cannot compare after dereferencing!"); 5740b57cec5SDimitry Andric #endif 575e8d8bef9SDimitry Andric return (const BaseT &)LHS == (const BaseT &)RHS; 5760b57cec5SDimitry Andric } 5770b57cec5SDimitry Andric }; 5780b57cec5SDimitry Andric 5790b57cec5SDimitry Andric /// Make a range that does early increment to allow mutation of the underlying 5800b57cec5SDimitry Andric /// range without disrupting iteration. 5810b57cec5SDimitry Andric /// 5820b57cec5SDimitry Andric /// The underlying iterator will be incremented immediately after it is 5830b57cec5SDimitry Andric /// dereferenced, allowing deletion of the current node or insertion of nodes to 5840b57cec5SDimitry Andric /// not disrupt iteration provided they do not invalidate the *next* iterator -- 5850b57cec5SDimitry Andric /// the current iterator can be invalidated. 5860b57cec5SDimitry Andric /// 5870b57cec5SDimitry Andric /// This requires a very exact pattern of use that is only really suitable to 5880b57cec5SDimitry Andric /// range based for loops and other range algorithms that explicitly guarantee 5890b57cec5SDimitry Andric /// to dereference exactly once each element, and to increment exactly once each 5900b57cec5SDimitry Andric /// element. 5910b57cec5SDimitry Andric template <typename RangeT> 5920b57cec5SDimitry Andric iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>> 5930b57cec5SDimitry Andric make_early_inc_range(RangeT &&Range) { 5940b57cec5SDimitry Andric using EarlyIncIteratorT = 5950b57cec5SDimitry Andric early_inc_iterator_impl<detail::IterOfRange<RangeT>>; 5960b57cec5SDimitry Andric return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))), 5970b57cec5SDimitry Andric EarlyIncIteratorT(std::end(std::forward<RangeT>(Range)))); 5980b57cec5SDimitry Andric } 5990b57cec5SDimitry Andric 6000b57cec5SDimitry Andric // forward declarations required by zip_shortest/zip_first/zip_longest 6010b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 6020b57cec5SDimitry Andric bool all_of(R &&range, UnaryPredicate P); 6030b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 6040b57cec5SDimitry Andric bool any_of(R &&range, UnaryPredicate P); 6050b57cec5SDimitry Andric 6060b57cec5SDimitry Andric namespace detail { 6070b57cec5SDimitry Andric 6080b57cec5SDimitry Andric using std::declval; 6090b57cec5SDimitry Andric 6100b57cec5SDimitry Andric // We have to alias this since inlining the actual type at the usage site 6110b57cec5SDimitry Andric // in the parameter list of iterator_facade_base<> below ICEs MSVC 2017. 6120b57cec5SDimitry Andric template<typename... Iters> struct ZipTupleType { 6130b57cec5SDimitry Andric using type = std::tuple<decltype(*declval<Iters>())...>; 6140b57cec5SDimitry Andric }; 6150b57cec5SDimitry Andric 6160b57cec5SDimitry Andric template <typename ZipType, typename... Iters> 6170b57cec5SDimitry Andric using zip_traits = iterator_facade_base< 6180b57cec5SDimitry Andric ZipType, typename std::common_type<std::bidirectional_iterator_tag, 6190b57cec5SDimitry Andric typename std::iterator_traits< 6200b57cec5SDimitry Andric Iters>::iterator_category...>::type, 6210b57cec5SDimitry Andric // ^ TODO: Implement random access methods. 6220b57cec5SDimitry Andric typename ZipTupleType<Iters...>::type, 6230b57cec5SDimitry Andric typename std::iterator_traits<typename std::tuple_element< 6240b57cec5SDimitry Andric 0, std::tuple<Iters...>>::type>::difference_type, 6250b57cec5SDimitry Andric // ^ FIXME: This follows boost::make_zip_iterator's assumption that all 6260b57cec5SDimitry Andric // inner iterators have the same difference_type. It would fail if, for 6270b57cec5SDimitry Andric // instance, the second field's difference_type were non-numeric while the 6280b57cec5SDimitry Andric // first is. 6290b57cec5SDimitry Andric typename ZipTupleType<Iters...>::type *, 6300b57cec5SDimitry Andric typename ZipTupleType<Iters...>::type>; 6310b57cec5SDimitry Andric 6320b57cec5SDimitry Andric template <typename ZipType, typename... Iters> 6330b57cec5SDimitry Andric struct zip_common : public zip_traits<ZipType, Iters...> { 6340b57cec5SDimitry Andric using Base = zip_traits<ZipType, Iters...>; 6350b57cec5SDimitry Andric using value_type = typename Base::value_type; 6360b57cec5SDimitry Andric 6370b57cec5SDimitry Andric std::tuple<Iters...> iterators; 6380b57cec5SDimitry Andric 6390b57cec5SDimitry Andric protected: 6408bcb0991SDimitry Andric template <size_t... Ns> value_type deref(std::index_sequence<Ns...>) const { 6410b57cec5SDimitry Andric return value_type(*std::get<Ns>(iterators)...); 6420b57cec5SDimitry Andric } 6430b57cec5SDimitry Andric 6440b57cec5SDimitry Andric template <size_t... Ns> 6458bcb0991SDimitry Andric decltype(iterators) tup_inc(std::index_sequence<Ns...>) const { 6460b57cec5SDimitry Andric return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...); 6470b57cec5SDimitry Andric } 6480b57cec5SDimitry Andric 6490b57cec5SDimitry Andric template <size_t... Ns> 6508bcb0991SDimitry Andric decltype(iterators) tup_dec(std::index_sequence<Ns...>) const { 6510b57cec5SDimitry Andric return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...); 6520b57cec5SDimitry Andric } 6530b57cec5SDimitry Andric 654*349cc55cSDimitry Andric template <size_t... Ns> 655*349cc55cSDimitry Andric bool test_all_equals(const zip_common &other, 656*349cc55cSDimitry Andric std::index_sequence<Ns...>) const { 657*349cc55cSDimitry Andric return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) == 658*349cc55cSDimitry Andric std::get<Ns>(other.iterators)...}, 659*349cc55cSDimitry Andric identity<bool>{}); 660*349cc55cSDimitry Andric } 661*349cc55cSDimitry Andric 6620b57cec5SDimitry Andric public: 6630b57cec5SDimitry Andric zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {} 6640b57cec5SDimitry Andric 665*349cc55cSDimitry Andric value_type operator*() const { 6668bcb0991SDimitry Andric return deref(std::index_sequence_for<Iters...>{}); 6670b57cec5SDimitry Andric } 6680b57cec5SDimitry Andric 6690b57cec5SDimitry Andric ZipType &operator++() { 6708bcb0991SDimitry Andric iterators = tup_inc(std::index_sequence_for<Iters...>{}); 6710b57cec5SDimitry Andric return *reinterpret_cast<ZipType *>(this); 6720b57cec5SDimitry Andric } 6730b57cec5SDimitry Andric 6740b57cec5SDimitry Andric ZipType &operator--() { 6750b57cec5SDimitry Andric static_assert(Base::IsBidirectional, 6760b57cec5SDimitry Andric "All inner iterators must be at least bidirectional."); 6778bcb0991SDimitry Andric iterators = tup_dec(std::index_sequence_for<Iters...>{}); 6780b57cec5SDimitry Andric return *reinterpret_cast<ZipType *>(this); 6790b57cec5SDimitry Andric } 680*349cc55cSDimitry Andric 681*349cc55cSDimitry Andric /// Return true if all the iterator are matching `other`'s iterators. 682*349cc55cSDimitry Andric bool all_equals(zip_common &other) { 683*349cc55cSDimitry Andric return test_all_equals(other, std::index_sequence_for<Iters...>{}); 684*349cc55cSDimitry Andric } 6850b57cec5SDimitry Andric }; 6860b57cec5SDimitry Andric 6870b57cec5SDimitry Andric template <typename... Iters> 6880b57cec5SDimitry Andric struct zip_first : public zip_common<zip_first<Iters...>, Iters...> { 6890b57cec5SDimitry Andric using Base = zip_common<zip_first<Iters...>, Iters...>; 6900b57cec5SDimitry Andric 6910b57cec5SDimitry Andric bool operator==(const zip_first<Iters...> &other) const { 6920b57cec5SDimitry Andric return std::get<0>(this->iterators) == std::get<0>(other.iterators); 6930b57cec5SDimitry Andric } 6940b57cec5SDimitry Andric 6950b57cec5SDimitry Andric zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} 6960b57cec5SDimitry Andric }; 6970b57cec5SDimitry Andric 6980b57cec5SDimitry Andric template <typename... Iters> 6990b57cec5SDimitry Andric class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> { 7000b57cec5SDimitry Andric template <size_t... Ns> 7018bcb0991SDimitry Andric bool test(const zip_shortest<Iters...> &other, 7028bcb0991SDimitry Andric std::index_sequence<Ns...>) const { 7030b57cec5SDimitry Andric return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) != 7040b57cec5SDimitry Andric std::get<Ns>(other.iterators)...}, 7050b57cec5SDimitry Andric identity<bool>{}); 7060b57cec5SDimitry Andric } 7070b57cec5SDimitry Andric 7080b57cec5SDimitry Andric public: 7090b57cec5SDimitry Andric using Base = zip_common<zip_shortest<Iters...>, Iters...>; 7100b57cec5SDimitry Andric 7110b57cec5SDimitry Andric zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} 7120b57cec5SDimitry Andric 7130b57cec5SDimitry Andric bool operator==(const zip_shortest<Iters...> &other) const { 7148bcb0991SDimitry Andric return !test(other, std::index_sequence_for<Iters...>{}); 7150b57cec5SDimitry Andric } 7160b57cec5SDimitry Andric }; 7170b57cec5SDimitry Andric 7180b57cec5SDimitry Andric template <template <typename...> class ItType, typename... Args> class zippy { 7190b57cec5SDimitry Andric public: 7200b57cec5SDimitry Andric using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>; 7210b57cec5SDimitry Andric using iterator_category = typename iterator::iterator_category; 7220b57cec5SDimitry Andric using value_type = typename iterator::value_type; 7230b57cec5SDimitry Andric using difference_type = typename iterator::difference_type; 7240b57cec5SDimitry Andric using pointer = typename iterator::pointer; 7250b57cec5SDimitry Andric using reference = typename iterator::reference; 7260b57cec5SDimitry Andric 7270b57cec5SDimitry Andric private: 7280b57cec5SDimitry Andric std::tuple<Args...> ts; 7290b57cec5SDimitry Andric 7308bcb0991SDimitry Andric template <size_t... Ns> 7318bcb0991SDimitry Andric iterator begin_impl(std::index_sequence<Ns...>) const { 7320b57cec5SDimitry Andric return iterator(std::begin(std::get<Ns>(ts))...); 7330b57cec5SDimitry Andric } 7348bcb0991SDimitry Andric template <size_t... Ns> iterator end_impl(std::index_sequence<Ns...>) const { 7350b57cec5SDimitry Andric return iterator(std::end(std::get<Ns>(ts))...); 7360b57cec5SDimitry Andric } 7370b57cec5SDimitry Andric 7380b57cec5SDimitry Andric public: 7390b57cec5SDimitry Andric zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} 7400b57cec5SDimitry Andric 7418bcb0991SDimitry Andric iterator begin() const { 7428bcb0991SDimitry Andric return begin_impl(std::index_sequence_for<Args...>{}); 7438bcb0991SDimitry Andric } 7448bcb0991SDimitry Andric iterator end() const { return end_impl(std::index_sequence_for<Args...>{}); } 7450b57cec5SDimitry Andric }; 7460b57cec5SDimitry Andric 7470b57cec5SDimitry Andric } // end namespace detail 7480b57cec5SDimitry Andric 7490b57cec5SDimitry Andric /// zip iterator for two or more iteratable types. 7500b57cec5SDimitry Andric template <typename T, typename U, typename... Args> 7510b57cec5SDimitry Andric detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u, 7520b57cec5SDimitry Andric Args &&... args) { 7530b57cec5SDimitry Andric return detail::zippy<detail::zip_shortest, T, U, Args...>( 7540b57cec5SDimitry Andric std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); 7550b57cec5SDimitry Andric } 7560b57cec5SDimitry Andric 7570b57cec5SDimitry Andric /// zip iterator that, for the sake of efficiency, assumes the first iteratee to 7580b57cec5SDimitry Andric /// be the shortest. 7590b57cec5SDimitry Andric template <typename T, typename U, typename... Args> 7600b57cec5SDimitry Andric detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u, 7610b57cec5SDimitry Andric Args &&... args) { 7620b57cec5SDimitry Andric return detail::zippy<detail::zip_first, T, U, Args...>( 7630b57cec5SDimitry Andric std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); 7640b57cec5SDimitry Andric } 7650b57cec5SDimitry Andric 7660b57cec5SDimitry Andric namespace detail { 7670b57cec5SDimitry Andric template <typename Iter> 7685ffd83dbSDimitry Andric Iter next_or_end(const Iter &I, const Iter &End) { 7690b57cec5SDimitry Andric if (I == End) 7700b57cec5SDimitry Andric return End; 7710b57cec5SDimitry Andric return std::next(I); 7720b57cec5SDimitry Andric } 7730b57cec5SDimitry Andric 7740b57cec5SDimitry Andric template <typename Iter> 7755ffd83dbSDimitry Andric auto deref_or_none(const Iter &I, const Iter &End) -> llvm::Optional< 7765ffd83dbSDimitry Andric std::remove_const_t<std::remove_reference_t<decltype(*I)>>> { 7770b57cec5SDimitry Andric if (I == End) 7780b57cec5SDimitry Andric return None; 7790b57cec5SDimitry Andric return *I; 7800b57cec5SDimitry Andric } 7810b57cec5SDimitry Andric 7820b57cec5SDimitry Andric template <typename Iter> struct ZipLongestItemType { 7830b57cec5SDimitry Andric using type = 7840b57cec5SDimitry Andric llvm::Optional<typename std::remove_const<typename std::remove_reference< 7850b57cec5SDimitry Andric decltype(*std::declval<Iter>())>::type>::type>; 7860b57cec5SDimitry Andric }; 7870b57cec5SDimitry Andric 7880b57cec5SDimitry Andric template <typename... Iters> struct ZipLongestTupleType { 7890b57cec5SDimitry Andric using type = std::tuple<typename ZipLongestItemType<Iters>::type...>; 7900b57cec5SDimitry Andric }; 7910b57cec5SDimitry Andric 7920b57cec5SDimitry Andric template <typename... Iters> 7930b57cec5SDimitry Andric class zip_longest_iterator 7940b57cec5SDimitry Andric : public iterator_facade_base< 7950b57cec5SDimitry Andric zip_longest_iterator<Iters...>, 7960b57cec5SDimitry Andric typename std::common_type< 7970b57cec5SDimitry Andric std::forward_iterator_tag, 7980b57cec5SDimitry Andric typename std::iterator_traits<Iters>::iterator_category...>::type, 7990b57cec5SDimitry Andric typename ZipLongestTupleType<Iters...>::type, 8000b57cec5SDimitry Andric typename std::iterator_traits<typename std::tuple_element< 8010b57cec5SDimitry Andric 0, std::tuple<Iters...>>::type>::difference_type, 8020b57cec5SDimitry Andric typename ZipLongestTupleType<Iters...>::type *, 8030b57cec5SDimitry Andric typename ZipLongestTupleType<Iters...>::type> { 8040b57cec5SDimitry Andric public: 8050b57cec5SDimitry Andric using value_type = typename ZipLongestTupleType<Iters...>::type; 8060b57cec5SDimitry Andric 8070b57cec5SDimitry Andric private: 8080b57cec5SDimitry Andric std::tuple<Iters...> iterators; 8090b57cec5SDimitry Andric std::tuple<Iters...> end_iterators; 8100b57cec5SDimitry Andric 8110b57cec5SDimitry Andric template <size_t... Ns> 8120b57cec5SDimitry Andric bool test(const zip_longest_iterator<Iters...> &other, 8138bcb0991SDimitry Andric std::index_sequence<Ns...>) const { 8140b57cec5SDimitry Andric return llvm::any_of( 8150b57cec5SDimitry Andric std::initializer_list<bool>{std::get<Ns>(this->iterators) != 8160b57cec5SDimitry Andric std::get<Ns>(other.iterators)...}, 8170b57cec5SDimitry Andric identity<bool>{}); 8180b57cec5SDimitry Andric } 8190b57cec5SDimitry Andric 8208bcb0991SDimitry Andric template <size_t... Ns> value_type deref(std::index_sequence<Ns...>) const { 8210b57cec5SDimitry Andric return value_type( 8220b57cec5SDimitry Andric deref_or_none(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...); 8230b57cec5SDimitry Andric } 8240b57cec5SDimitry Andric 8250b57cec5SDimitry Andric template <size_t... Ns> 8268bcb0991SDimitry Andric decltype(iterators) tup_inc(std::index_sequence<Ns...>) const { 8270b57cec5SDimitry Andric return std::tuple<Iters...>( 8280b57cec5SDimitry Andric next_or_end(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...); 8290b57cec5SDimitry Andric } 8300b57cec5SDimitry Andric 8310b57cec5SDimitry Andric public: 8320b57cec5SDimitry Andric zip_longest_iterator(std::pair<Iters &&, Iters &&>... ts) 8330b57cec5SDimitry Andric : iterators(std::forward<Iters>(ts.first)...), 8340b57cec5SDimitry Andric end_iterators(std::forward<Iters>(ts.second)...) {} 8350b57cec5SDimitry Andric 8368bcb0991SDimitry Andric value_type operator*() const { 8378bcb0991SDimitry Andric return deref(std::index_sequence_for<Iters...>{}); 8388bcb0991SDimitry Andric } 8390b57cec5SDimitry Andric 8400b57cec5SDimitry Andric zip_longest_iterator<Iters...> &operator++() { 8418bcb0991SDimitry Andric iterators = tup_inc(std::index_sequence_for<Iters...>{}); 8420b57cec5SDimitry Andric return *this; 8430b57cec5SDimitry Andric } 8440b57cec5SDimitry Andric 8450b57cec5SDimitry Andric bool operator==(const zip_longest_iterator<Iters...> &other) const { 8468bcb0991SDimitry Andric return !test(other, std::index_sequence_for<Iters...>{}); 8470b57cec5SDimitry Andric } 8480b57cec5SDimitry Andric }; 8490b57cec5SDimitry Andric 8500b57cec5SDimitry Andric template <typename... Args> class zip_longest_range { 8510b57cec5SDimitry Andric public: 8520b57cec5SDimitry Andric using iterator = 8530b57cec5SDimitry Andric zip_longest_iterator<decltype(adl_begin(std::declval<Args>()))...>; 8540b57cec5SDimitry Andric using iterator_category = typename iterator::iterator_category; 8550b57cec5SDimitry Andric using value_type = typename iterator::value_type; 8560b57cec5SDimitry Andric using difference_type = typename iterator::difference_type; 8570b57cec5SDimitry Andric using pointer = typename iterator::pointer; 8580b57cec5SDimitry Andric using reference = typename iterator::reference; 8590b57cec5SDimitry Andric 8600b57cec5SDimitry Andric private: 8610b57cec5SDimitry Andric std::tuple<Args...> ts; 8620b57cec5SDimitry Andric 8638bcb0991SDimitry Andric template <size_t... Ns> 8648bcb0991SDimitry Andric iterator begin_impl(std::index_sequence<Ns...>) const { 8650b57cec5SDimitry Andric return iterator(std::make_pair(adl_begin(std::get<Ns>(ts)), 8660b57cec5SDimitry Andric adl_end(std::get<Ns>(ts)))...); 8670b57cec5SDimitry Andric } 8680b57cec5SDimitry Andric 8698bcb0991SDimitry Andric template <size_t... Ns> iterator end_impl(std::index_sequence<Ns...>) const { 8700b57cec5SDimitry Andric return iterator(std::make_pair(adl_end(std::get<Ns>(ts)), 8710b57cec5SDimitry Andric adl_end(std::get<Ns>(ts)))...); 8720b57cec5SDimitry Andric } 8730b57cec5SDimitry Andric 8740b57cec5SDimitry Andric public: 8750b57cec5SDimitry Andric zip_longest_range(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} 8760b57cec5SDimitry Andric 8778bcb0991SDimitry Andric iterator begin() const { 8788bcb0991SDimitry Andric return begin_impl(std::index_sequence_for<Args...>{}); 8798bcb0991SDimitry Andric } 8808bcb0991SDimitry Andric iterator end() const { return end_impl(std::index_sequence_for<Args...>{}); } 8810b57cec5SDimitry Andric }; 8820b57cec5SDimitry Andric } // namespace detail 8830b57cec5SDimitry Andric 8840b57cec5SDimitry Andric /// Iterate over two or more iterators at the same time. Iteration continues 8850b57cec5SDimitry Andric /// until all iterators reach the end. The llvm::Optional only contains a value 8860b57cec5SDimitry Andric /// if the iterator has not reached the end. 8870b57cec5SDimitry Andric template <typename T, typename U, typename... Args> 8880b57cec5SDimitry Andric detail::zip_longest_range<T, U, Args...> zip_longest(T &&t, U &&u, 8890b57cec5SDimitry Andric Args &&... args) { 8900b57cec5SDimitry Andric return detail::zip_longest_range<T, U, Args...>( 8910b57cec5SDimitry Andric std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); 8920b57cec5SDimitry Andric } 8930b57cec5SDimitry Andric 8940b57cec5SDimitry Andric /// Iterator wrapper that concatenates sequences together. 8950b57cec5SDimitry Andric /// 8960b57cec5SDimitry Andric /// This can concatenate different iterators, even with different types, into 8970b57cec5SDimitry Andric /// a single iterator provided the value types of all the concatenated 8980b57cec5SDimitry Andric /// iterators expose `reference` and `pointer` types that can be converted to 8990b57cec5SDimitry Andric /// `ValueT &` and `ValueT *` respectively. It doesn't support more 9000b57cec5SDimitry Andric /// interesting/customized pointer or reference types. 9010b57cec5SDimitry Andric /// 9020b57cec5SDimitry Andric /// Currently this only supports forward or higher iterator categories as 9030b57cec5SDimitry Andric /// inputs and always exposes a forward iterator interface. 9040b57cec5SDimitry Andric template <typename ValueT, typename... IterTs> 9050b57cec5SDimitry Andric class concat_iterator 9060b57cec5SDimitry Andric : public iterator_facade_base<concat_iterator<ValueT, IterTs...>, 9070b57cec5SDimitry Andric std::forward_iterator_tag, ValueT> { 9080b57cec5SDimitry Andric using BaseT = typename concat_iterator::iterator_facade_base; 9090b57cec5SDimitry Andric 9100b57cec5SDimitry Andric /// We store both the current and end iterators for each concatenated 9110b57cec5SDimitry Andric /// sequence in a tuple of pairs. 9120b57cec5SDimitry Andric /// 9130b57cec5SDimitry Andric /// Note that something like iterator_range seems nice at first here, but the 9140b57cec5SDimitry Andric /// range properties are of little benefit and end up getting in the way 9150b57cec5SDimitry Andric /// because we need to do mutation on the current iterators. 9160b57cec5SDimitry Andric std::tuple<IterTs...> Begins; 9170b57cec5SDimitry Andric std::tuple<IterTs...> Ends; 9180b57cec5SDimitry Andric 9190b57cec5SDimitry Andric /// Attempts to increment a specific iterator. 9200b57cec5SDimitry Andric /// 9210b57cec5SDimitry Andric /// Returns true if it was able to increment the iterator. Returns false if 9220b57cec5SDimitry Andric /// the iterator is already at the end iterator. 9230b57cec5SDimitry Andric template <size_t Index> bool incrementHelper() { 9240b57cec5SDimitry Andric auto &Begin = std::get<Index>(Begins); 9250b57cec5SDimitry Andric auto &End = std::get<Index>(Ends); 9260b57cec5SDimitry Andric if (Begin == End) 9270b57cec5SDimitry Andric return false; 9280b57cec5SDimitry Andric 9290b57cec5SDimitry Andric ++Begin; 9300b57cec5SDimitry Andric return true; 9310b57cec5SDimitry Andric } 9320b57cec5SDimitry Andric 9330b57cec5SDimitry Andric /// Increments the first non-end iterator. 9340b57cec5SDimitry Andric /// 9350b57cec5SDimitry Andric /// It is an error to call this with all iterators at the end. 9368bcb0991SDimitry Andric template <size_t... Ns> void increment(std::index_sequence<Ns...>) { 9370b57cec5SDimitry Andric // Build a sequence of functions to increment each iterator if possible. 9380b57cec5SDimitry Andric bool (concat_iterator::*IncrementHelperFns[])() = { 9390b57cec5SDimitry Andric &concat_iterator::incrementHelper<Ns>...}; 9400b57cec5SDimitry Andric 9410b57cec5SDimitry Andric // Loop over them, and stop as soon as we succeed at incrementing one. 9420b57cec5SDimitry Andric for (auto &IncrementHelperFn : IncrementHelperFns) 9430b57cec5SDimitry Andric if ((this->*IncrementHelperFn)()) 9440b57cec5SDimitry Andric return; 9450b57cec5SDimitry Andric 9460b57cec5SDimitry Andric llvm_unreachable("Attempted to increment an end concat iterator!"); 9470b57cec5SDimitry Andric } 9480b57cec5SDimitry Andric 9490b57cec5SDimitry Andric /// Returns null if the specified iterator is at the end. Otherwise, 9500b57cec5SDimitry Andric /// dereferences the iterator and returns the address of the resulting 9510b57cec5SDimitry Andric /// reference. 9520b57cec5SDimitry Andric template <size_t Index> ValueT *getHelper() const { 9530b57cec5SDimitry Andric auto &Begin = std::get<Index>(Begins); 9540b57cec5SDimitry Andric auto &End = std::get<Index>(Ends); 9550b57cec5SDimitry Andric if (Begin == End) 9560b57cec5SDimitry Andric return nullptr; 9570b57cec5SDimitry Andric 9580b57cec5SDimitry Andric return &*Begin; 9590b57cec5SDimitry Andric } 9600b57cec5SDimitry Andric 9610b57cec5SDimitry Andric /// Finds the first non-end iterator, dereferences, and returns the resulting 9620b57cec5SDimitry Andric /// reference. 9630b57cec5SDimitry Andric /// 9640b57cec5SDimitry Andric /// It is an error to call this with all iterators at the end. 9658bcb0991SDimitry Andric template <size_t... Ns> ValueT &get(std::index_sequence<Ns...>) const { 9660b57cec5SDimitry Andric // Build a sequence of functions to get from iterator if possible. 9670b57cec5SDimitry Andric ValueT *(concat_iterator::*GetHelperFns[])() const = { 9680b57cec5SDimitry Andric &concat_iterator::getHelper<Ns>...}; 9690b57cec5SDimitry Andric 9700b57cec5SDimitry Andric // Loop over them, and return the first result we find. 9710b57cec5SDimitry Andric for (auto &GetHelperFn : GetHelperFns) 9720b57cec5SDimitry Andric if (ValueT *P = (this->*GetHelperFn)()) 9730b57cec5SDimitry Andric return *P; 9740b57cec5SDimitry Andric 9750b57cec5SDimitry Andric llvm_unreachable("Attempted to get a pointer from an end concat iterator!"); 9760b57cec5SDimitry Andric } 9770b57cec5SDimitry Andric 9780b57cec5SDimitry Andric public: 9795ffd83dbSDimitry Andric /// Constructs an iterator from a sequence of ranges. 9800b57cec5SDimitry Andric /// 9810b57cec5SDimitry Andric /// We need the full range to know how to switch between each of the 9820b57cec5SDimitry Andric /// iterators. 9830b57cec5SDimitry Andric template <typename... RangeTs> 9840b57cec5SDimitry Andric explicit concat_iterator(RangeTs &&... Ranges) 9850b57cec5SDimitry Andric : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {} 9860b57cec5SDimitry Andric 9870b57cec5SDimitry Andric using BaseT::operator++; 9880b57cec5SDimitry Andric 9890b57cec5SDimitry Andric concat_iterator &operator++() { 9908bcb0991SDimitry Andric increment(std::index_sequence_for<IterTs...>()); 9910b57cec5SDimitry Andric return *this; 9920b57cec5SDimitry Andric } 9930b57cec5SDimitry Andric 9948bcb0991SDimitry Andric ValueT &operator*() const { 9958bcb0991SDimitry Andric return get(std::index_sequence_for<IterTs...>()); 9968bcb0991SDimitry Andric } 9970b57cec5SDimitry Andric 9980b57cec5SDimitry Andric bool operator==(const concat_iterator &RHS) const { 9990b57cec5SDimitry Andric return Begins == RHS.Begins && Ends == RHS.Ends; 10000b57cec5SDimitry Andric } 10010b57cec5SDimitry Andric }; 10020b57cec5SDimitry Andric 10030b57cec5SDimitry Andric namespace detail { 10040b57cec5SDimitry Andric 10050b57cec5SDimitry Andric /// Helper to store a sequence of ranges being concatenated and access them. 10060b57cec5SDimitry Andric /// 10070b57cec5SDimitry Andric /// This is designed to facilitate providing actual storage when temporaries 10080b57cec5SDimitry Andric /// are passed into the constructor such that we can use it as part of range 10090b57cec5SDimitry Andric /// based for loops. 10100b57cec5SDimitry Andric template <typename ValueT, typename... RangeTs> class concat_range { 10110b57cec5SDimitry Andric public: 10120b57cec5SDimitry Andric using iterator = 10130b57cec5SDimitry Andric concat_iterator<ValueT, 10140b57cec5SDimitry Andric decltype(std::begin(std::declval<RangeTs &>()))...>; 10150b57cec5SDimitry Andric 10160b57cec5SDimitry Andric private: 10170b57cec5SDimitry Andric std::tuple<RangeTs...> Ranges; 10180b57cec5SDimitry Andric 10198bcb0991SDimitry Andric template <size_t... Ns> iterator begin_impl(std::index_sequence<Ns...>) { 10200b57cec5SDimitry Andric return iterator(std::get<Ns>(Ranges)...); 10210b57cec5SDimitry Andric } 10228bcb0991SDimitry Andric template <size_t... Ns> iterator end_impl(std::index_sequence<Ns...>) { 10230b57cec5SDimitry Andric return iterator(make_range(std::end(std::get<Ns>(Ranges)), 10240b57cec5SDimitry Andric std::end(std::get<Ns>(Ranges)))...); 10250b57cec5SDimitry Andric } 10260b57cec5SDimitry Andric 10270b57cec5SDimitry Andric public: 10280b57cec5SDimitry Andric concat_range(RangeTs &&... Ranges) 10290b57cec5SDimitry Andric : Ranges(std::forward<RangeTs>(Ranges)...) {} 10300b57cec5SDimitry Andric 10318bcb0991SDimitry Andric iterator begin() { return begin_impl(std::index_sequence_for<RangeTs...>{}); } 10328bcb0991SDimitry Andric iterator end() { return end_impl(std::index_sequence_for<RangeTs...>{}); } 10330b57cec5SDimitry Andric }; 10340b57cec5SDimitry Andric 10350b57cec5SDimitry Andric } // end namespace detail 10360b57cec5SDimitry Andric 10370b57cec5SDimitry Andric /// Concatenated range across two or more ranges. 10380b57cec5SDimitry Andric /// 10390b57cec5SDimitry Andric /// The desired value type must be explicitly specified. 10400b57cec5SDimitry Andric template <typename ValueT, typename... RangeTs> 10410b57cec5SDimitry Andric detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) { 10420b57cec5SDimitry Andric static_assert(sizeof...(RangeTs) > 1, 10430b57cec5SDimitry Andric "Need more than one range to concatenate!"); 10440b57cec5SDimitry Andric return detail::concat_range<ValueT, RangeTs...>( 10450b57cec5SDimitry Andric std::forward<RangeTs>(Ranges)...); 10460b57cec5SDimitry Andric } 10470b57cec5SDimitry Andric 10485ffd83dbSDimitry Andric /// A utility class used to implement an iterator that contains some base object 10495ffd83dbSDimitry Andric /// and an index. The iterator moves the index but keeps the base constant. 10505ffd83dbSDimitry Andric template <typename DerivedT, typename BaseT, typename T, 10515ffd83dbSDimitry Andric typename PointerT = T *, typename ReferenceT = T &> 10525ffd83dbSDimitry Andric class indexed_accessor_iterator 10535ffd83dbSDimitry Andric : public llvm::iterator_facade_base<DerivedT, 10545ffd83dbSDimitry Andric std::random_access_iterator_tag, T, 10555ffd83dbSDimitry Andric std::ptrdiff_t, PointerT, ReferenceT> { 10565ffd83dbSDimitry Andric public: 10575ffd83dbSDimitry Andric ptrdiff_t operator-(const indexed_accessor_iterator &rhs) const { 10585ffd83dbSDimitry Andric assert(base == rhs.base && "incompatible iterators"); 10595ffd83dbSDimitry Andric return index - rhs.index; 10605ffd83dbSDimitry Andric } 10615ffd83dbSDimitry Andric bool operator==(const indexed_accessor_iterator &rhs) const { 10625ffd83dbSDimitry Andric return base == rhs.base && index == rhs.index; 10635ffd83dbSDimitry Andric } 10645ffd83dbSDimitry Andric bool operator<(const indexed_accessor_iterator &rhs) const { 10655ffd83dbSDimitry Andric assert(base == rhs.base && "incompatible iterators"); 10665ffd83dbSDimitry Andric return index < rhs.index; 10675ffd83dbSDimitry Andric } 10685ffd83dbSDimitry Andric 10695ffd83dbSDimitry Andric DerivedT &operator+=(ptrdiff_t offset) { 10705ffd83dbSDimitry Andric this->index += offset; 10715ffd83dbSDimitry Andric return static_cast<DerivedT &>(*this); 10725ffd83dbSDimitry Andric } 10735ffd83dbSDimitry Andric DerivedT &operator-=(ptrdiff_t offset) { 10745ffd83dbSDimitry Andric this->index -= offset; 10755ffd83dbSDimitry Andric return static_cast<DerivedT &>(*this); 10765ffd83dbSDimitry Andric } 10775ffd83dbSDimitry Andric 10785ffd83dbSDimitry Andric /// Returns the current index of the iterator. 10795ffd83dbSDimitry Andric ptrdiff_t getIndex() const { return index; } 10805ffd83dbSDimitry Andric 10815ffd83dbSDimitry Andric /// Returns the current base of the iterator. 10825ffd83dbSDimitry Andric const BaseT &getBase() const { return base; } 10835ffd83dbSDimitry Andric 10845ffd83dbSDimitry Andric protected: 10855ffd83dbSDimitry Andric indexed_accessor_iterator(BaseT base, ptrdiff_t index) 10865ffd83dbSDimitry Andric : base(base), index(index) {} 10875ffd83dbSDimitry Andric BaseT base; 10885ffd83dbSDimitry Andric ptrdiff_t index; 10895ffd83dbSDimitry Andric }; 10905ffd83dbSDimitry Andric 10915ffd83dbSDimitry Andric namespace detail { 10925ffd83dbSDimitry Andric /// The class represents the base of a range of indexed_accessor_iterators. It 10935ffd83dbSDimitry Andric /// provides support for many different range functionalities, e.g. 10945ffd83dbSDimitry Andric /// drop_front/slice/etc.. Derived range classes must implement the following 10955ffd83dbSDimitry Andric /// static methods: 10965ffd83dbSDimitry Andric /// * ReferenceT dereference_iterator(const BaseT &base, ptrdiff_t index) 10975ffd83dbSDimitry Andric /// - Dereference an iterator pointing to the base object at the given 10985ffd83dbSDimitry Andric /// index. 10995ffd83dbSDimitry Andric /// * BaseT offset_base(const BaseT &base, ptrdiff_t index) 11005ffd83dbSDimitry Andric /// - Return a new base that is offset from the provide base by 'index' 11015ffd83dbSDimitry Andric /// elements. 11025ffd83dbSDimitry Andric template <typename DerivedT, typename BaseT, typename T, 11035ffd83dbSDimitry Andric typename PointerT = T *, typename ReferenceT = T &> 11045ffd83dbSDimitry Andric class indexed_accessor_range_base { 11055ffd83dbSDimitry Andric public: 1106*349cc55cSDimitry Andric using RangeBaseT = indexed_accessor_range_base; 11075ffd83dbSDimitry Andric 11085ffd83dbSDimitry Andric /// An iterator element of this range. 11095ffd83dbSDimitry Andric class iterator : public indexed_accessor_iterator<iterator, BaseT, T, 11105ffd83dbSDimitry Andric PointerT, ReferenceT> { 11115ffd83dbSDimitry Andric public: 11125ffd83dbSDimitry Andric // Index into this iterator, invoking a static method on the derived type. 11135ffd83dbSDimitry Andric ReferenceT operator*() const { 11145ffd83dbSDimitry Andric return DerivedT::dereference_iterator(this->getBase(), this->getIndex()); 11155ffd83dbSDimitry Andric } 11165ffd83dbSDimitry Andric 11175ffd83dbSDimitry Andric private: 11185ffd83dbSDimitry Andric iterator(BaseT owner, ptrdiff_t curIndex) 1119*349cc55cSDimitry Andric : iterator::indexed_accessor_iterator(owner, curIndex) {} 11205ffd83dbSDimitry Andric 11215ffd83dbSDimitry Andric /// Allow access to the constructor. 11225ffd83dbSDimitry Andric friend indexed_accessor_range_base<DerivedT, BaseT, T, PointerT, 11235ffd83dbSDimitry Andric ReferenceT>; 11245ffd83dbSDimitry Andric }; 11255ffd83dbSDimitry Andric 11265ffd83dbSDimitry Andric indexed_accessor_range_base(iterator begin, iterator end) 11275ffd83dbSDimitry Andric : base(offset_base(begin.getBase(), begin.getIndex())), 11285ffd83dbSDimitry Andric count(end.getIndex() - begin.getIndex()) {} 11295ffd83dbSDimitry Andric indexed_accessor_range_base(const iterator_range<iterator> &range) 11305ffd83dbSDimitry Andric : indexed_accessor_range_base(range.begin(), range.end()) {} 11315ffd83dbSDimitry Andric indexed_accessor_range_base(BaseT base, ptrdiff_t count) 11325ffd83dbSDimitry Andric : base(base), count(count) {} 11335ffd83dbSDimitry Andric 11345ffd83dbSDimitry Andric iterator begin() const { return iterator(base, 0); } 11355ffd83dbSDimitry Andric iterator end() const { return iterator(base, count); } 1136fe6060f1SDimitry Andric ReferenceT operator[](size_t Index) const { 1137fe6060f1SDimitry Andric assert(Index < size() && "invalid index for value range"); 1138fe6060f1SDimitry Andric return DerivedT::dereference_iterator(base, static_cast<ptrdiff_t>(Index)); 11395ffd83dbSDimitry Andric } 11405ffd83dbSDimitry Andric ReferenceT front() const { 11415ffd83dbSDimitry Andric assert(!empty() && "expected non-empty range"); 11425ffd83dbSDimitry Andric return (*this)[0]; 11435ffd83dbSDimitry Andric } 11445ffd83dbSDimitry Andric ReferenceT back() const { 11455ffd83dbSDimitry Andric assert(!empty() && "expected non-empty range"); 11465ffd83dbSDimitry Andric return (*this)[size() - 1]; 11475ffd83dbSDimitry Andric } 11485ffd83dbSDimitry Andric 11495ffd83dbSDimitry Andric /// Compare this range with another. 11505ffd83dbSDimitry Andric template <typename OtherT> bool operator==(const OtherT &other) const { 11515ffd83dbSDimitry Andric return size() == 11525ffd83dbSDimitry Andric static_cast<size_t>(std::distance(other.begin(), other.end())) && 11535ffd83dbSDimitry Andric std::equal(begin(), end(), other.begin()); 11545ffd83dbSDimitry Andric } 11555ffd83dbSDimitry Andric template <typename OtherT> bool operator!=(const OtherT &other) const { 11565ffd83dbSDimitry Andric return !(*this == other); 11575ffd83dbSDimitry Andric } 11585ffd83dbSDimitry Andric 11595ffd83dbSDimitry Andric /// Return the size of this range. 11605ffd83dbSDimitry Andric size_t size() const { return count; } 11615ffd83dbSDimitry Andric 11625ffd83dbSDimitry Andric /// Return if the range is empty. 11635ffd83dbSDimitry Andric bool empty() const { return size() == 0; } 11645ffd83dbSDimitry Andric 11655ffd83dbSDimitry Andric /// Drop the first N elements, and keep M elements. 11665ffd83dbSDimitry Andric DerivedT slice(size_t n, size_t m) const { 11675ffd83dbSDimitry Andric assert(n + m <= size() && "invalid size specifiers"); 11685ffd83dbSDimitry Andric return DerivedT(offset_base(base, n), m); 11695ffd83dbSDimitry Andric } 11705ffd83dbSDimitry Andric 11715ffd83dbSDimitry Andric /// Drop the first n elements. 11725ffd83dbSDimitry Andric DerivedT drop_front(size_t n = 1) const { 11735ffd83dbSDimitry Andric assert(size() >= n && "Dropping more elements than exist"); 11745ffd83dbSDimitry Andric return slice(n, size() - n); 11755ffd83dbSDimitry Andric } 11765ffd83dbSDimitry Andric /// Drop the last n elements. 11775ffd83dbSDimitry Andric DerivedT drop_back(size_t n = 1) const { 11785ffd83dbSDimitry Andric assert(size() >= n && "Dropping more elements than exist"); 11795ffd83dbSDimitry Andric return DerivedT(base, size() - n); 11805ffd83dbSDimitry Andric } 11815ffd83dbSDimitry Andric 11825ffd83dbSDimitry Andric /// Take the first n elements. 11835ffd83dbSDimitry Andric DerivedT take_front(size_t n = 1) const { 11845ffd83dbSDimitry Andric return n < size() ? drop_back(size() - n) 11855ffd83dbSDimitry Andric : static_cast<const DerivedT &>(*this); 11865ffd83dbSDimitry Andric } 11875ffd83dbSDimitry Andric 11885ffd83dbSDimitry Andric /// Take the last n elements. 11895ffd83dbSDimitry Andric DerivedT take_back(size_t n = 1) const { 11905ffd83dbSDimitry Andric return n < size() ? drop_front(size() - n) 11915ffd83dbSDimitry Andric : static_cast<const DerivedT &>(*this); 11925ffd83dbSDimitry Andric } 11935ffd83dbSDimitry Andric 11945ffd83dbSDimitry Andric /// Allow conversion to any type accepting an iterator_range. 11955ffd83dbSDimitry Andric template <typename RangeT, typename = std::enable_if_t<std::is_constructible< 11965ffd83dbSDimitry Andric RangeT, iterator_range<iterator>>::value>> 11975ffd83dbSDimitry Andric operator RangeT() const { 11985ffd83dbSDimitry Andric return RangeT(iterator_range<iterator>(*this)); 11995ffd83dbSDimitry Andric } 12005ffd83dbSDimitry Andric 12015ffd83dbSDimitry Andric /// Returns the base of this range. 12025ffd83dbSDimitry Andric const BaseT &getBase() const { return base; } 12035ffd83dbSDimitry Andric 12045ffd83dbSDimitry Andric private: 12055ffd83dbSDimitry Andric /// Offset the given base by the given amount. 12065ffd83dbSDimitry Andric static BaseT offset_base(const BaseT &base, size_t n) { 12075ffd83dbSDimitry Andric return n == 0 ? base : DerivedT::offset_base(base, n); 12085ffd83dbSDimitry Andric } 12095ffd83dbSDimitry Andric 12105ffd83dbSDimitry Andric protected: 12115ffd83dbSDimitry Andric indexed_accessor_range_base(const indexed_accessor_range_base &) = default; 12125ffd83dbSDimitry Andric indexed_accessor_range_base(indexed_accessor_range_base &&) = default; 12135ffd83dbSDimitry Andric indexed_accessor_range_base & 12145ffd83dbSDimitry Andric operator=(const indexed_accessor_range_base &) = default; 12155ffd83dbSDimitry Andric 12165ffd83dbSDimitry Andric /// The base that owns the provided range of values. 12175ffd83dbSDimitry Andric BaseT base; 12185ffd83dbSDimitry Andric /// The size from the owning range. 12195ffd83dbSDimitry Andric ptrdiff_t count; 12205ffd83dbSDimitry Andric }; 12215ffd83dbSDimitry Andric } // end namespace detail 12225ffd83dbSDimitry Andric 12235ffd83dbSDimitry Andric /// This class provides an implementation of a range of 12245ffd83dbSDimitry Andric /// indexed_accessor_iterators where the base is not indexable. Ranges with 12255ffd83dbSDimitry Andric /// bases that are offsetable should derive from indexed_accessor_range_base 12265ffd83dbSDimitry Andric /// instead. Derived range classes are expected to implement the following 12275ffd83dbSDimitry Andric /// static method: 12285ffd83dbSDimitry Andric /// * ReferenceT dereference(const BaseT &base, ptrdiff_t index) 12295ffd83dbSDimitry Andric /// - Dereference an iterator pointing to a parent base at the given index. 12305ffd83dbSDimitry Andric template <typename DerivedT, typename BaseT, typename T, 12315ffd83dbSDimitry Andric typename PointerT = T *, typename ReferenceT = T &> 12325ffd83dbSDimitry Andric class indexed_accessor_range 12335ffd83dbSDimitry Andric : public detail::indexed_accessor_range_base< 12345ffd83dbSDimitry Andric DerivedT, std::pair<BaseT, ptrdiff_t>, T, PointerT, ReferenceT> { 12355ffd83dbSDimitry Andric public: 12365ffd83dbSDimitry Andric indexed_accessor_range(BaseT base, ptrdiff_t startIndex, ptrdiff_t count) 12375ffd83dbSDimitry Andric : detail::indexed_accessor_range_base< 12385ffd83dbSDimitry Andric DerivedT, std::pair<BaseT, ptrdiff_t>, T, PointerT, ReferenceT>( 12395ffd83dbSDimitry Andric std::make_pair(base, startIndex), count) {} 12405ffd83dbSDimitry Andric using detail::indexed_accessor_range_base< 12415ffd83dbSDimitry Andric DerivedT, std::pair<BaseT, ptrdiff_t>, T, PointerT, 12425ffd83dbSDimitry Andric ReferenceT>::indexed_accessor_range_base; 12435ffd83dbSDimitry Andric 12445ffd83dbSDimitry Andric /// Returns the current base of the range. 12455ffd83dbSDimitry Andric const BaseT &getBase() const { return this->base.first; } 12465ffd83dbSDimitry Andric 12475ffd83dbSDimitry Andric /// Returns the current start index of the range. 12485ffd83dbSDimitry Andric ptrdiff_t getStartIndex() const { return this->base.second; } 12495ffd83dbSDimitry Andric 12505ffd83dbSDimitry Andric /// See `detail::indexed_accessor_range_base` for details. 12515ffd83dbSDimitry Andric static std::pair<BaseT, ptrdiff_t> 12525ffd83dbSDimitry Andric offset_base(const std::pair<BaseT, ptrdiff_t> &base, ptrdiff_t index) { 12535ffd83dbSDimitry Andric // We encode the internal base as a pair of the derived base and a start 12545ffd83dbSDimitry Andric // index into the derived base. 12555ffd83dbSDimitry Andric return std::make_pair(base.first, base.second + index); 12565ffd83dbSDimitry Andric } 12575ffd83dbSDimitry Andric /// See `detail::indexed_accessor_range_base` for details. 12585ffd83dbSDimitry Andric static ReferenceT 12595ffd83dbSDimitry Andric dereference_iterator(const std::pair<BaseT, ptrdiff_t> &base, 12605ffd83dbSDimitry Andric ptrdiff_t index) { 12615ffd83dbSDimitry Andric return DerivedT::dereference(base.first, base.second + index); 12625ffd83dbSDimitry Andric } 12635ffd83dbSDimitry Andric }; 12645ffd83dbSDimitry Andric 1265*349cc55cSDimitry Andric namespace detail { 1266*349cc55cSDimitry Andric /// Return a reference to the first or second member of a reference. Otherwise, 1267*349cc55cSDimitry Andric /// return a copy of the member of a temporary. 1268*349cc55cSDimitry Andric /// 1269*349cc55cSDimitry Andric /// When passing a range whose iterators return values instead of references, 1270*349cc55cSDimitry Andric /// the reference must be dropped from `decltype((elt.first))`, which will 1271*349cc55cSDimitry Andric /// always be a reference, to avoid returning a reference to a temporary. 1272*349cc55cSDimitry Andric template <typename EltTy, typename FirstTy> class first_or_second_type { 1273*349cc55cSDimitry Andric public: 1274*349cc55cSDimitry Andric using type = 1275*349cc55cSDimitry Andric typename std::conditional_t<std::is_reference<EltTy>::value, FirstTy, 1276*349cc55cSDimitry Andric std::remove_reference_t<FirstTy>>; 1277*349cc55cSDimitry Andric }; 1278*349cc55cSDimitry Andric } // end namespace detail 1279*349cc55cSDimitry Andric 1280e8d8bef9SDimitry Andric /// Given a container of pairs, return a range over the first elements. 1281e8d8bef9SDimitry Andric template <typename ContainerTy> auto make_first_range(ContainerTy &&c) { 1282*349cc55cSDimitry Andric using EltTy = decltype((*std::begin(c))); 1283*349cc55cSDimitry Andric return llvm::map_range(std::forward<ContainerTy>(c), 1284*349cc55cSDimitry Andric [](EltTy elt) -> typename detail::first_or_second_type< 1285*349cc55cSDimitry Andric EltTy, decltype((elt.first))>::type { 1286e8d8bef9SDimitry Andric return elt.first; 1287e8d8bef9SDimitry Andric }); 1288e8d8bef9SDimitry Andric } 1289e8d8bef9SDimitry Andric 12905ffd83dbSDimitry Andric /// Given a container of pairs, return a range over the second elements. 12915ffd83dbSDimitry Andric template <typename ContainerTy> auto make_second_range(ContainerTy &&c) { 1292*349cc55cSDimitry Andric using EltTy = decltype((*std::begin(c))); 12935ffd83dbSDimitry Andric return llvm::map_range( 12945ffd83dbSDimitry Andric std::forward<ContainerTy>(c), 1295*349cc55cSDimitry Andric [](EltTy elt) -> 1296*349cc55cSDimitry Andric typename detail::first_or_second_type<EltTy, 1297*349cc55cSDimitry Andric decltype((elt.second))>::type { 12985ffd83dbSDimitry Andric return elt.second; 12995ffd83dbSDimitry Andric }); 13005ffd83dbSDimitry Andric } 13015ffd83dbSDimitry Andric 13020b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 13030b57cec5SDimitry Andric // Extra additions to <utility> 13040b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 13050b57cec5SDimitry Andric 13060b57cec5SDimitry Andric /// Function object to check whether the first component of a std::pair 13070b57cec5SDimitry Andric /// compares less than the first component of another std::pair. 13080b57cec5SDimitry Andric struct less_first { 13090b57cec5SDimitry Andric template <typename T> bool operator()(const T &lhs, const T &rhs) const { 1310*349cc55cSDimitry Andric return std::less<>()(lhs.first, rhs.first); 13110b57cec5SDimitry Andric } 13120b57cec5SDimitry Andric }; 13130b57cec5SDimitry Andric 13140b57cec5SDimitry Andric /// Function object to check whether the second component of a std::pair 13150b57cec5SDimitry Andric /// compares less than the second component of another std::pair. 13160b57cec5SDimitry Andric struct less_second { 13170b57cec5SDimitry Andric template <typename T> bool operator()(const T &lhs, const T &rhs) const { 1318*349cc55cSDimitry Andric return std::less<>()(lhs.second, rhs.second); 13190b57cec5SDimitry Andric } 13200b57cec5SDimitry Andric }; 13210b57cec5SDimitry Andric 13220b57cec5SDimitry Andric /// \brief Function object to apply a binary function to the first component of 13230b57cec5SDimitry Andric /// a std::pair. 13240b57cec5SDimitry Andric template<typename FuncTy> 13250b57cec5SDimitry Andric struct on_first { 13260b57cec5SDimitry Andric FuncTy func; 13270b57cec5SDimitry Andric 13280b57cec5SDimitry Andric template <typename T> 13295ffd83dbSDimitry Andric decltype(auto) operator()(const T &lhs, const T &rhs) const { 13300b57cec5SDimitry Andric return func(lhs.first, rhs.first); 13310b57cec5SDimitry Andric } 13320b57cec5SDimitry Andric }; 13330b57cec5SDimitry Andric 13340b57cec5SDimitry Andric /// Utility type to build an inheritance chain that makes it easy to rank 13350b57cec5SDimitry Andric /// overload candidates. 13360b57cec5SDimitry Andric template <int N> struct rank : rank<N - 1> {}; 13370b57cec5SDimitry Andric template <> struct rank<0> {}; 13380b57cec5SDimitry Andric 13390b57cec5SDimitry Andric /// traits class for checking whether type T is one of any of the given 13400b57cec5SDimitry Andric /// types in the variadic list. 1341fe6060f1SDimitry Andric template <typename T, typename... Ts> 1342fe6060f1SDimitry Andric using is_one_of = disjunction<std::is_same<T, Ts>...>; 13430b57cec5SDimitry Andric 13440b57cec5SDimitry Andric /// traits class for checking whether type T is a base class for all 13450b57cec5SDimitry Andric /// the given types in the variadic list. 1346fe6060f1SDimitry Andric template <typename T, typename... Ts> 1347fe6060f1SDimitry Andric using are_base_of = conjunction<std::is_base_of<T, Ts>...>; 1348fe6060f1SDimitry Andric 1349fe6060f1SDimitry Andric namespace detail { 1350fe6060f1SDimitry Andric template <typename... Ts> struct Visitor; 1351fe6060f1SDimitry Andric 1352fe6060f1SDimitry Andric template <typename HeadT, typename... TailTs> 1353fe6060f1SDimitry Andric struct Visitor<HeadT, TailTs...> : remove_cvref_t<HeadT>, Visitor<TailTs...> { 1354fe6060f1SDimitry Andric explicit constexpr Visitor(HeadT &&Head, TailTs &&...Tail) 1355fe6060f1SDimitry Andric : remove_cvref_t<HeadT>(std::forward<HeadT>(Head)), 1356fe6060f1SDimitry Andric Visitor<TailTs...>(std::forward<TailTs>(Tail)...) {} 1357fe6060f1SDimitry Andric using remove_cvref_t<HeadT>::operator(); 1358fe6060f1SDimitry Andric using Visitor<TailTs...>::operator(); 13590b57cec5SDimitry Andric }; 13600b57cec5SDimitry Andric 1361fe6060f1SDimitry Andric template <typename HeadT> struct Visitor<HeadT> : remove_cvref_t<HeadT> { 1362fe6060f1SDimitry Andric explicit constexpr Visitor(HeadT &&Head) 1363fe6060f1SDimitry Andric : remove_cvref_t<HeadT>(std::forward<HeadT>(Head)) {} 1364fe6060f1SDimitry Andric using remove_cvref_t<HeadT>::operator(); 13650b57cec5SDimitry Andric }; 1366fe6060f1SDimitry Andric } // namespace detail 1367fe6060f1SDimitry Andric 1368fe6060f1SDimitry Andric /// Returns an opaquely-typed Callable object whose operator() overload set is 1369fe6060f1SDimitry Andric /// the sum of the operator() overload sets of each CallableT in CallableTs. 1370fe6060f1SDimitry Andric /// 1371fe6060f1SDimitry Andric /// The type of the returned object derives from each CallableT in CallableTs. 1372fe6060f1SDimitry Andric /// The returned object is constructed by invoking the appropriate copy or move 1373fe6060f1SDimitry Andric /// constructor of each CallableT, as selected by overload resolution on the 1374fe6060f1SDimitry Andric /// corresponding argument to makeVisitor. 1375fe6060f1SDimitry Andric /// 1376fe6060f1SDimitry Andric /// Example: 1377fe6060f1SDimitry Andric /// 1378fe6060f1SDimitry Andric /// \code 1379fe6060f1SDimitry Andric /// auto visitor = makeVisitor([](auto) { return "unhandled type"; }, 1380fe6060f1SDimitry Andric /// [](int i) { return "int"; }, 1381fe6060f1SDimitry Andric /// [](std::string s) { return "str"; }); 1382fe6060f1SDimitry Andric /// auto a = visitor(42); // `a` is now "int". 1383fe6060f1SDimitry Andric /// auto b = visitor("foo"); // `b` is now "str". 1384fe6060f1SDimitry Andric /// auto c = visitor(3.14f); // `c` is now "unhandled type". 1385fe6060f1SDimitry Andric /// \endcode 1386fe6060f1SDimitry Andric /// 1387fe6060f1SDimitry Andric /// Example of making a visitor with a lambda which captures a move-only type: 1388fe6060f1SDimitry Andric /// 1389fe6060f1SDimitry Andric /// \code 1390fe6060f1SDimitry Andric /// std::unique_ptr<FooHandler> FH = /* ... */; 1391fe6060f1SDimitry Andric /// auto visitor = makeVisitor( 1392fe6060f1SDimitry Andric /// [FH{std::move(FH)}](Foo F) { return FH->handle(F); }, 1393fe6060f1SDimitry Andric /// [](int i) { return i; }, 1394fe6060f1SDimitry Andric /// [](std::string s) { return atoi(s); }); 1395fe6060f1SDimitry Andric /// \endcode 1396fe6060f1SDimitry Andric template <typename... CallableTs> 1397fe6060f1SDimitry Andric constexpr decltype(auto) makeVisitor(CallableTs &&...Callables) { 1398fe6060f1SDimitry Andric return detail::Visitor<CallableTs...>(std::forward<CallableTs>(Callables)...); 1399fe6060f1SDimitry Andric } 14000b57cec5SDimitry Andric 14010b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 14020b57cec5SDimitry Andric // Extra additions for arrays 14030b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 14040b57cec5SDimitry Andric 14055ffd83dbSDimitry Andric // We have a copy here so that LLVM behaves the same when using different 14065ffd83dbSDimitry Andric // standard libraries. 14075ffd83dbSDimitry Andric template <class Iterator, class RNG> 14085ffd83dbSDimitry Andric void shuffle(Iterator first, Iterator last, RNG &&g) { 14095ffd83dbSDimitry Andric // It would be better to use a std::uniform_int_distribution, 14105ffd83dbSDimitry Andric // but that would be stdlib dependent. 1411fe6060f1SDimitry Andric typedef 1412fe6060f1SDimitry Andric typename std::iterator_traits<Iterator>::difference_type difference_type; 1413fe6060f1SDimitry Andric for (auto size = last - first; size > 1; ++first, (void)--size) { 1414fe6060f1SDimitry Andric difference_type offset = g() % size; 1415fe6060f1SDimitry Andric // Avoid self-assignment due to incorrect assertions in libstdc++ 1416fe6060f1SDimitry Andric // containers (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=85828). 1417fe6060f1SDimitry Andric if (offset != difference_type(0)) 1418fe6060f1SDimitry Andric std::iter_swap(first, first + offset); 1419fe6060f1SDimitry Andric } 14205ffd83dbSDimitry Andric } 14215ffd83dbSDimitry Andric 14220b57cec5SDimitry Andric /// Find the length of an array. 14230b57cec5SDimitry Andric template <class T, std::size_t N> 14240b57cec5SDimitry Andric constexpr inline size_t array_lengthof(T (&)[N]) { 14250b57cec5SDimitry Andric return N; 14260b57cec5SDimitry Andric } 14270b57cec5SDimitry Andric 14280b57cec5SDimitry Andric /// Adapt std::less<T> for array_pod_sort. 14290b57cec5SDimitry Andric template<typename T> 14300b57cec5SDimitry Andric inline int array_pod_sort_comparator(const void *P1, const void *P2) { 14310b57cec5SDimitry Andric if (std::less<T>()(*reinterpret_cast<const T*>(P1), 14320b57cec5SDimitry Andric *reinterpret_cast<const T*>(P2))) 14330b57cec5SDimitry Andric return -1; 14340b57cec5SDimitry Andric if (std::less<T>()(*reinterpret_cast<const T*>(P2), 14350b57cec5SDimitry Andric *reinterpret_cast<const T*>(P1))) 14360b57cec5SDimitry Andric return 1; 14370b57cec5SDimitry Andric return 0; 14380b57cec5SDimitry Andric } 14390b57cec5SDimitry Andric 14400b57cec5SDimitry Andric /// get_array_pod_sort_comparator - This is an internal helper function used to 14410b57cec5SDimitry Andric /// get type deduction of T right. 14420b57cec5SDimitry Andric template<typename T> 14430b57cec5SDimitry Andric inline int (*get_array_pod_sort_comparator(const T &)) 14440b57cec5SDimitry Andric (const void*, const void*) { 14450b57cec5SDimitry Andric return array_pod_sort_comparator<T>; 14460b57cec5SDimitry Andric } 14470b57cec5SDimitry Andric 1448480093f4SDimitry Andric #ifdef EXPENSIVE_CHECKS 1449480093f4SDimitry Andric namespace detail { 1450480093f4SDimitry Andric 1451480093f4SDimitry Andric inline unsigned presortShuffleEntropy() { 1452480093f4SDimitry Andric static unsigned Result(std::random_device{}()); 1453480093f4SDimitry Andric return Result; 1454480093f4SDimitry Andric } 1455480093f4SDimitry Andric 1456480093f4SDimitry Andric template <class IteratorTy> 1457480093f4SDimitry Andric inline void presortShuffle(IteratorTy Start, IteratorTy End) { 1458480093f4SDimitry Andric std::mt19937 Generator(presortShuffleEntropy()); 1459fe6060f1SDimitry Andric llvm::shuffle(Start, End, Generator); 1460480093f4SDimitry Andric } 1461480093f4SDimitry Andric 1462480093f4SDimitry Andric } // end namespace detail 1463480093f4SDimitry Andric #endif 1464480093f4SDimitry Andric 14650b57cec5SDimitry Andric /// array_pod_sort - This sorts an array with the specified start and end 14660b57cec5SDimitry Andric /// extent. This is just like std::sort, except that it calls qsort instead of 14670b57cec5SDimitry Andric /// using an inlined template. qsort is slightly slower than std::sort, but 14680b57cec5SDimitry Andric /// most sorts are not performance critical in LLVM and std::sort has to be 14690b57cec5SDimitry Andric /// template instantiated for each type, leading to significant measured code 14700b57cec5SDimitry Andric /// bloat. This function should generally be used instead of std::sort where 14710b57cec5SDimitry Andric /// possible. 14720b57cec5SDimitry Andric /// 14730b57cec5SDimitry Andric /// This function assumes that you have simple POD-like types that can be 14740b57cec5SDimitry Andric /// compared with std::less and can be moved with memcpy. If this isn't true, 14750b57cec5SDimitry Andric /// you should use std::sort. 14760b57cec5SDimitry Andric /// 14770b57cec5SDimitry Andric /// NOTE: If qsort_r were portable, we could allow a custom comparator and 14780b57cec5SDimitry Andric /// default to std::less. 14790b57cec5SDimitry Andric template<class IteratorTy> 14800b57cec5SDimitry Andric inline void array_pod_sort(IteratorTy Start, IteratorTy End) { 14810b57cec5SDimitry Andric // Don't inefficiently call qsort with one element or trigger undefined 14820b57cec5SDimitry Andric // behavior with an empty sequence. 14830b57cec5SDimitry Andric auto NElts = End - Start; 14840b57cec5SDimitry Andric if (NElts <= 1) return; 14850b57cec5SDimitry Andric #ifdef EXPENSIVE_CHECKS 1486480093f4SDimitry Andric detail::presortShuffle<IteratorTy>(Start, End); 14870b57cec5SDimitry Andric #endif 14880b57cec5SDimitry Andric qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start)); 14890b57cec5SDimitry Andric } 14900b57cec5SDimitry Andric 14910b57cec5SDimitry Andric template <class IteratorTy> 14920b57cec5SDimitry Andric inline void array_pod_sort( 14930b57cec5SDimitry Andric IteratorTy Start, IteratorTy End, 14940b57cec5SDimitry Andric int (*Compare)( 14950b57cec5SDimitry Andric const typename std::iterator_traits<IteratorTy>::value_type *, 14960b57cec5SDimitry Andric const typename std::iterator_traits<IteratorTy>::value_type *)) { 14970b57cec5SDimitry Andric // Don't inefficiently call qsort with one element or trigger undefined 14980b57cec5SDimitry Andric // behavior with an empty sequence. 14990b57cec5SDimitry Andric auto NElts = End - Start; 15000b57cec5SDimitry Andric if (NElts <= 1) return; 15010b57cec5SDimitry Andric #ifdef EXPENSIVE_CHECKS 1502480093f4SDimitry Andric detail::presortShuffle<IteratorTy>(Start, End); 15030b57cec5SDimitry Andric #endif 15040b57cec5SDimitry Andric qsort(&*Start, NElts, sizeof(*Start), 15050b57cec5SDimitry Andric reinterpret_cast<int (*)(const void *, const void *)>(Compare)); 15060b57cec5SDimitry Andric } 15070b57cec5SDimitry Andric 15085ffd83dbSDimitry Andric namespace detail { 15095ffd83dbSDimitry Andric template <typename T> 15105ffd83dbSDimitry Andric // We can use qsort if the iterator type is a pointer and the underlying value 15115ffd83dbSDimitry Andric // is trivially copyable. 15125ffd83dbSDimitry Andric using sort_trivially_copyable = conjunction< 15135ffd83dbSDimitry Andric std::is_pointer<T>, 1514e8d8bef9SDimitry Andric std::is_trivially_copyable<typename std::iterator_traits<T>::value_type>>; 15155ffd83dbSDimitry Andric } // namespace detail 15165ffd83dbSDimitry Andric 15170b57cec5SDimitry Andric // Provide wrappers to std::sort which shuffle the elements before sorting 15180b57cec5SDimitry Andric // to help uncover non-deterministic behavior (PR35135). 15195ffd83dbSDimitry Andric template <typename IteratorTy, 15205ffd83dbSDimitry Andric std::enable_if_t<!detail::sort_trivially_copyable<IteratorTy>::value, 15215ffd83dbSDimitry Andric int> = 0> 15220b57cec5SDimitry Andric inline void sort(IteratorTy Start, IteratorTy End) { 15230b57cec5SDimitry Andric #ifdef EXPENSIVE_CHECKS 1524480093f4SDimitry Andric detail::presortShuffle<IteratorTy>(Start, End); 15250b57cec5SDimitry Andric #endif 15260b57cec5SDimitry Andric std::sort(Start, End); 15270b57cec5SDimitry Andric } 15280b57cec5SDimitry Andric 15295ffd83dbSDimitry Andric // Forward trivially copyable types to array_pod_sort. This avoids a large 15305ffd83dbSDimitry Andric // amount of code bloat for a minor performance hit. 15315ffd83dbSDimitry Andric template <typename IteratorTy, 15325ffd83dbSDimitry Andric std::enable_if_t<detail::sort_trivially_copyable<IteratorTy>::value, 15335ffd83dbSDimitry Andric int> = 0> 15345ffd83dbSDimitry Andric inline void sort(IteratorTy Start, IteratorTy End) { 15355ffd83dbSDimitry Andric array_pod_sort(Start, End); 15365ffd83dbSDimitry Andric } 15375ffd83dbSDimitry Andric 15380b57cec5SDimitry Andric template <typename Container> inline void sort(Container &&C) { 15390b57cec5SDimitry Andric llvm::sort(adl_begin(C), adl_end(C)); 15400b57cec5SDimitry Andric } 15410b57cec5SDimitry Andric 15420b57cec5SDimitry Andric template <typename IteratorTy, typename Compare> 15430b57cec5SDimitry Andric inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) { 15440b57cec5SDimitry Andric #ifdef EXPENSIVE_CHECKS 1545480093f4SDimitry Andric detail::presortShuffle<IteratorTy>(Start, End); 15460b57cec5SDimitry Andric #endif 15470b57cec5SDimitry Andric std::sort(Start, End, Comp); 15480b57cec5SDimitry Andric } 15490b57cec5SDimitry Andric 15500b57cec5SDimitry Andric template <typename Container, typename Compare> 15510b57cec5SDimitry Andric inline void sort(Container &&C, Compare Comp) { 15520b57cec5SDimitry Andric llvm::sort(adl_begin(C), adl_end(C), Comp); 15530b57cec5SDimitry Andric } 15540b57cec5SDimitry Andric 15550b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 15560b57cec5SDimitry Andric // Extra additions to <algorithm> 15570b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 15580b57cec5SDimitry Andric 15590b57cec5SDimitry Andric /// Get the size of a range. This is a wrapper function around std::distance 15600b57cec5SDimitry Andric /// which is only enabled when the operation is O(1). 15610b57cec5SDimitry Andric template <typename R> 15625ffd83dbSDimitry Andric auto size(R &&Range, 1563e8d8bef9SDimitry Andric std::enable_if_t< 1564e8d8bef9SDimitry Andric std::is_base_of<std::random_access_iterator_tag, 1565e8d8bef9SDimitry Andric typename std::iterator_traits<decltype( 1566e8d8bef9SDimitry Andric Range.begin())>::iterator_category>::value, 15675ffd83dbSDimitry Andric void> * = nullptr) { 15680b57cec5SDimitry Andric return std::distance(Range.begin(), Range.end()); 15690b57cec5SDimitry Andric } 15700b57cec5SDimitry Andric 15710b57cec5SDimitry Andric /// Provide wrappers to std::for_each which take ranges instead of having to 15720b57cec5SDimitry Andric /// pass begin/end explicitly. 1573e8d8bef9SDimitry Andric template <typename R, typename UnaryFunction> 1574e8d8bef9SDimitry Andric UnaryFunction for_each(R &&Range, UnaryFunction F) { 1575e8d8bef9SDimitry Andric return std::for_each(adl_begin(Range), adl_end(Range), F); 15760b57cec5SDimitry Andric } 15770b57cec5SDimitry Andric 15780b57cec5SDimitry Andric /// Provide wrappers to std::all_of which take ranges instead of having to pass 15790b57cec5SDimitry Andric /// begin/end explicitly. 15800b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 15810b57cec5SDimitry Andric bool all_of(R &&Range, UnaryPredicate P) { 15820b57cec5SDimitry Andric return std::all_of(adl_begin(Range), adl_end(Range), P); 15830b57cec5SDimitry Andric } 15840b57cec5SDimitry Andric 15850b57cec5SDimitry Andric /// Provide wrappers to std::any_of which take ranges instead of having to pass 15860b57cec5SDimitry Andric /// begin/end explicitly. 15870b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 15880b57cec5SDimitry Andric bool any_of(R &&Range, UnaryPredicate P) { 15890b57cec5SDimitry Andric return std::any_of(adl_begin(Range), adl_end(Range), P); 15900b57cec5SDimitry Andric } 15910b57cec5SDimitry Andric 15920b57cec5SDimitry Andric /// Provide wrappers to std::none_of which take ranges instead of having to pass 15930b57cec5SDimitry Andric /// begin/end explicitly. 15940b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 15950b57cec5SDimitry Andric bool none_of(R &&Range, UnaryPredicate P) { 15960b57cec5SDimitry Andric return std::none_of(adl_begin(Range), adl_end(Range), P); 15970b57cec5SDimitry Andric } 15980b57cec5SDimitry Andric 15990b57cec5SDimitry Andric /// Provide wrappers to std::find which take ranges instead of having to pass 16000b57cec5SDimitry Andric /// begin/end explicitly. 16015ffd83dbSDimitry Andric template <typename R, typename T> auto find(R &&Range, const T &Val) { 16020b57cec5SDimitry Andric return std::find(adl_begin(Range), adl_end(Range), Val); 16030b57cec5SDimitry Andric } 16040b57cec5SDimitry Andric 16050b57cec5SDimitry Andric /// Provide wrappers to std::find_if which take ranges instead of having to pass 16060b57cec5SDimitry Andric /// begin/end explicitly. 16070b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 16085ffd83dbSDimitry Andric auto find_if(R &&Range, UnaryPredicate P) { 16090b57cec5SDimitry Andric return std::find_if(adl_begin(Range), adl_end(Range), P); 16100b57cec5SDimitry Andric } 16110b57cec5SDimitry Andric 16120b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 16135ffd83dbSDimitry Andric auto find_if_not(R &&Range, UnaryPredicate P) { 16140b57cec5SDimitry Andric return std::find_if_not(adl_begin(Range), adl_end(Range), P); 16150b57cec5SDimitry Andric } 16160b57cec5SDimitry Andric 16170b57cec5SDimitry Andric /// Provide wrappers to std::remove_if which take ranges instead of having to 16180b57cec5SDimitry Andric /// pass begin/end explicitly. 16190b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 16205ffd83dbSDimitry Andric auto remove_if(R &&Range, UnaryPredicate P) { 16210b57cec5SDimitry Andric return std::remove_if(adl_begin(Range), adl_end(Range), P); 16220b57cec5SDimitry Andric } 16230b57cec5SDimitry Andric 16240b57cec5SDimitry Andric /// Provide wrappers to std::copy_if which take ranges instead of having to 16250b57cec5SDimitry Andric /// pass begin/end explicitly. 16260b57cec5SDimitry Andric template <typename R, typename OutputIt, typename UnaryPredicate> 16270b57cec5SDimitry Andric OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) { 16280b57cec5SDimitry Andric return std::copy_if(adl_begin(Range), adl_end(Range), Out, P); 16290b57cec5SDimitry Andric } 16300b57cec5SDimitry Andric 16310b57cec5SDimitry Andric template <typename R, typename OutputIt> 16320b57cec5SDimitry Andric OutputIt copy(R &&Range, OutputIt Out) { 16330b57cec5SDimitry Andric return std::copy(adl_begin(Range), adl_end(Range), Out); 16340b57cec5SDimitry Andric } 16350b57cec5SDimitry Andric 1636e8d8bef9SDimitry Andric /// Provide wrappers to std::move which take ranges instead of having to 1637e8d8bef9SDimitry Andric /// pass begin/end explicitly. 1638e8d8bef9SDimitry Andric template <typename R, typename OutputIt> 1639e8d8bef9SDimitry Andric OutputIt move(R &&Range, OutputIt Out) { 1640e8d8bef9SDimitry Andric return std::move(adl_begin(Range), adl_end(Range), Out); 1641e8d8bef9SDimitry Andric } 1642e8d8bef9SDimitry Andric 16430b57cec5SDimitry Andric /// Wrapper function around std::find to detect if an element exists 16440b57cec5SDimitry Andric /// in a container. 16450b57cec5SDimitry Andric template <typename R, typename E> 16460b57cec5SDimitry Andric bool is_contained(R &&Range, const E &Element) { 16470b57cec5SDimitry Andric return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range); 16480b57cec5SDimitry Andric } 16490b57cec5SDimitry Andric 16505ffd83dbSDimitry Andric /// Wrapper function around std::is_sorted to check if elements in a range \p R 16515ffd83dbSDimitry Andric /// are sorted with respect to a comparator \p C. 16525ffd83dbSDimitry Andric template <typename R, typename Compare> bool is_sorted(R &&Range, Compare C) { 16535ffd83dbSDimitry Andric return std::is_sorted(adl_begin(Range), adl_end(Range), C); 16545ffd83dbSDimitry Andric } 16555ffd83dbSDimitry Andric 16565ffd83dbSDimitry Andric /// Wrapper function around std::is_sorted to check if elements in a range \p R 16575ffd83dbSDimitry Andric /// are sorted in non-descending order. 16585ffd83dbSDimitry Andric template <typename R> bool is_sorted(R &&Range) { 16595ffd83dbSDimitry Andric return std::is_sorted(adl_begin(Range), adl_end(Range)); 16605ffd83dbSDimitry Andric } 16615ffd83dbSDimitry Andric 16620b57cec5SDimitry Andric /// Wrapper function around std::count to count the number of times an element 16630b57cec5SDimitry Andric /// \p Element occurs in the given range \p Range. 16645ffd83dbSDimitry Andric template <typename R, typename E> auto count(R &&Range, const E &Element) { 16650b57cec5SDimitry Andric return std::count(adl_begin(Range), adl_end(Range), Element); 16660b57cec5SDimitry Andric } 16670b57cec5SDimitry Andric 16680b57cec5SDimitry Andric /// Wrapper function around std::count_if to count the number of times an 16690b57cec5SDimitry Andric /// element satisfying a given predicate occurs in a range. 16700b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 16715ffd83dbSDimitry Andric auto count_if(R &&Range, UnaryPredicate P) { 16720b57cec5SDimitry Andric return std::count_if(adl_begin(Range), adl_end(Range), P); 16730b57cec5SDimitry Andric } 16740b57cec5SDimitry Andric 16750b57cec5SDimitry Andric /// Wrapper function around std::transform to apply a function to a range and 16760b57cec5SDimitry Andric /// store the result elsewhere. 1677e8d8bef9SDimitry Andric template <typename R, typename OutputIt, typename UnaryFunction> 1678e8d8bef9SDimitry Andric OutputIt transform(R &&Range, OutputIt d_first, UnaryFunction F) { 1679e8d8bef9SDimitry Andric return std::transform(adl_begin(Range), adl_end(Range), d_first, F); 16800b57cec5SDimitry Andric } 16810b57cec5SDimitry Andric 16820b57cec5SDimitry Andric /// Provide wrappers to std::partition which take ranges instead of having to 16830b57cec5SDimitry Andric /// pass begin/end explicitly. 16840b57cec5SDimitry Andric template <typename R, typename UnaryPredicate> 16855ffd83dbSDimitry Andric auto partition(R &&Range, UnaryPredicate P) { 16860b57cec5SDimitry Andric return std::partition(adl_begin(Range), adl_end(Range), P); 16870b57cec5SDimitry Andric } 16880b57cec5SDimitry Andric 16890b57cec5SDimitry Andric /// Provide wrappers to std::lower_bound which take ranges instead of having to 16900b57cec5SDimitry Andric /// pass begin/end explicitly. 16915ffd83dbSDimitry Andric template <typename R, typename T> auto lower_bound(R &&Range, T &&Value) { 16920b57cec5SDimitry Andric return std::lower_bound(adl_begin(Range), adl_end(Range), 16930b57cec5SDimitry Andric std::forward<T>(Value)); 16940b57cec5SDimitry Andric } 16950b57cec5SDimitry Andric 16960b57cec5SDimitry Andric template <typename R, typename T, typename Compare> 16975ffd83dbSDimitry Andric auto lower_bound(R &&Range, T &&Value, Compare C) { 16980b57cec5SDimitry Andric return std::lower_bound(adl_begin(Range), adl_end(Range), 16990b57cec5SDimitry Andric std::forward<T>(Value), C); 17000b57cec5SDimitry Andric } 17010b57cec5SDimitry Andric 17020b57cec5SDimitry Andric /// Provide wrappers to std::upper_bound which take ranges instead of having to 17030b57cec5SDimitry Andric /// pass begin/end explicitly. 17045ffd83dbSDimitry Andric template <typename R, typename T> auto upper_bound(R &&Range, T &&Value) { 17050b57cec5SDimitry Andric return std::upper_bound(adl_begin(Range), adl_end(Range), 17060b57cec5SDimitry Andric std::forward<T>(Value)); 17070b57cec5SDimitry Andric } 17080b57cec5SDimitry Andric 17090b57cec5SDimitry Andric template <typename R, typename T, typename Compare> 17105ffd83dbSDimitry Andric auto upper_bound(R &&Range, T &&Value, Compare C) { 17110b57cec5SDimitry Andric return std::upper_bound(adl_begin(Range), adl_end(Range), 17120b57cec5SDimitry Andric std::forward<T>(Value), C); 17130b57cec5SDimitry Andric } 17140b57cec5SDimitry Andric 17150b57cec5SDimitry Andric template <typename R> 17160b57cec5SDimitry Andric void stable_sort(R &&Range) { 17170b57cec5SDimitry Andric std::stable_sort(adl_begin(Range), adl_end(Range)); 17180b57cec5SDimitry Andric } 17190b57cec5SDimitry Andric 17200b57cec5SDimitry Andric template <typename R, typename Compare> 17210b57cec5SDimitry Andric void stable_sort(R &&Range, Compare C) { 17220b57cec5SDimitry Andric std::stable_sort(adl_begin(Range), adl_end(Range), C); 17230b57cec5SDimitry Andric } 17240b57cec5SDimitry Andric 17250b57cec5SDimitry Andric /// Binary search for the first iterator in a range where a predicate is false. 17260b57cec5SDimitry Andric /// Requires that C is always true below some limit, and always false above it. 17270b57cec5SDimitry Andric template <typename R, typename Predicate, 17280b57cec5SDimitry Andric typename Val = decltype(*adl_begin(std::declval<R>()))> 17295ffd83dbSDimitry Andric auto partition_point(R &&Range, Predicate P) { 17300b57cec5SDimitry Andric return std::partition_point(adl_begin(Range), adl_end(Range), P); 17310b57cec5SDimitry Andric } 17320b57cec5SDimitry Andric 1733fe6060f1SDimitry Andric template<typename Range, typename Predicate> 1734fe6060f1SDimitry Andric auto unique(Range &&R, Predicate P) { 1735fe6060f1SDimitry Andric return std::unique(adl_begin(R), adl_end(R), P); 1736fe6060f1SDimitry Andric } 1737fe6060f1SDimitry Andric 1738fe6060f1SDimitry Andric /// Wrapper function around std::equal to detect if pair-wise elements between 1739fe6060f1SDimitry Andric /// two ranges are the same. 1740fe6060f1SDimitry Andric template <typename L, typename R> bool equal(L &&LRange, R &&RRange) { 1741fe6060f1SDimitry Andric return std::equal(adl_begin(LRange), adl_end(LRange), adl_begin(RRange), 1742fe6060f1SDimitry Andric adl_end(RRange)); 1743fe6060f1SDimitry Andric } 1744fe6060f1SDimitry Andric 17450b57cec5SDimitry Andric /// Wrapper function around std::equal to detect if all elements 17460b57cec5SDimitry Andric /// in a container are same. 17470b57cec5SDimitry Andric template <typename R> 17480b57cec5SDimitry Andric bool is_splat(R &&Range) { 17490b57cec5SDimitry Andric size_t range_size = size(Range); 17500b57cec5SDimitry Andric return range_size != 0 && (range_size == 1 || 17510b57cec5SDimitry Andric std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range))); 17520b57cec5SDimitry Andric } 17530b57cec5SDimitry Andric 17540b57cec5SDimitry Andric /// Provide a container algorithm similar to C++ Library Fundamentals v2's 17550b57cec5SDimitry Andric /// `erase_if` which is equivalent to: 17560b57cec5SDimitry Andric /// 17570b57cec5SDimitry Andric /// C.erase(remove_if(C, pred), C.end()); 17580b57cec5SDimitry Andric /// 17590b57cec5SDimitry Andric /// This version works for any container with an erase method call accepting 17600b57cec5SDimitry Andric /// two iterators. 17610b57cec5SDimitry Andric template <typename Container, typename UnaryPredicate> 17620b57cec5SDimitry Andric void erase_if(Container &C, UnaryPredicate P) { 17630b57cec5SDimitry Andric C.erase(remove_if(C, P), C.end()); 17640b57cec5SDimitry Andric } 17650b57cec5SDimitry Andric 1766e8d8bef9SDimitry Andric /// Wrapper function to remove a value from a container: 1767e8d8bef9SDimitry Andric /// 1768e8d8bef9SDimitry Andric /// C.erase(remove(C.begin(), C.end(), V), C.end()); 1769e8d8bef9SDimitry Andric template <typename Container, typename ValueType> 1770e8d8bef9SDimitry Andric void erase_value(Container &C, ValueType V) { 1771e8d8bef9SDimitry Andric C.erase(std::remove(C.begin(), C.end(), V), C.end()); 1772e8d8bef9SDimitry Andric } 1773e8d8bef9SDimitry Andric 1774e8d8bef9SDimitry Andric /// Wrapper function to append a range to a container. 1775e8d8bef9SDimitry Andric /// 1776e8d8bef9SDimitry Andric /// C.insert(C.end(), R.begin(), R.end()); 1777e8d8bef9SDimitry Andric template <typename Container, typename Range> 1778e8d8bef9SDimitry Andric inline void append_range(Container &C, Range &&R) { 1779e8d8bef9SDimitry Andric C.insert(C.end(), R.begin(), R.end()); 1780e8d8bef9SDimitry Andric } 1781e8d8bef9SDimitry Andric 17820b57cec5SDimitry Andric /// Given a sequence container Cont, replace the range [ContIt, ContEnd) with 17830b57cec5SDimitry Andric /// the range [ValIt, ValEnd) (which is not from the same container). 17840b57cec5SDimitry Andric template<typename Container, typename RandomAccessIterator> 17850b57cec5SDimitry Andric void replace(Container &Cont, typename Container::iterator ContIt, 17860b57cec5SDimitry Andric typename Container::iterator ContEnd, RandomAccessIterator ValIt, 17870b57cec5SDimitry Andric RandomAccessIterator ValEnd) { 17880b57cec5SDimitry Andric while (true) { 17890b57cec5SDimitry Andric if (ValIt == ValEnd) { 17900b57cec5SDimitry Andric Cont.erase(ContIt, ContEnd); 17910b57cec5SDimitry Andric return; 17920b57cec5SDimitry Andric } else if (ContIt == ContEnd) { 17930b57cec5SDimitry Andric Cont.insert(ContIt, ValIt, ValEnd); 17940b57cec5SDimitry Andric return; 17950b57cec5SDimitry Andric } 17960b57cec5SDimitry Andric *ContIt++ = *ValIt++; 17970b57cec5SDimitry Andric } 17980b57cec5SDimitry Andric } 17990b57cec5SDimitry Andric 18000b57cec5SDimitry Andric /// Given a sequence container Cont, replace the range [ContIt, ContEnd) with 18010b57cec5SDimitry Andric /// the range R. 18020b57cec5SDimitry Andric template<typename Container, typename Range = std::initializer_list< 18030b57cec5SDimitry Andric typename Container::value_type>> 18040b57cec5SDimitry Andric void replace(Container &Cont, typename Container::iterator ContIt, 18050b57cec5SDimitry Andric typename Container::iterator ContEnd, Range R) { 18060b57cec5SDimitry Andric replace(Cont, ContIt, ContEnd, R.begin(), R.end()); 18070b57cec5SDimitry Andric } 18080b57cec5SDimitry Andric 18095ffd83dbSDimitry Andric /// An STL-style algorithm similar to std::for_each that applies a second 18105ffd83dbSDimitry Andric /// functor between every pair of elements. 18115ffd83dbSDimitry Andric /// 18125ffd83dbSDimitry Andric /// This provides the control flow logic to, for example, print a 18135ffd83dbSDimitry Andric /// comma-separated list: 18145ffd83dbSDimitry Andric /// \code 18155ffd83dbSDimitry Andric /// interleave(names.begin(), names.end(), 18165ffd83dbSDimitry Andric /// [&](StringRef name) { os << name; }, 18175ffd83dbSDimitry Andric /// [&] { os << ", "; }); 18185ffd83dbSDimitry Andric /// \endcode 18195ffd83dbSDimitry Andric template <typename ForwardIterator, typename UnaryFunctor, 18205ffd83dbSDimitry Andric typename NullaryFunctor, 18215ffd83dbSDimitry Andric typename = typename std::enable_if< 18225ffd83dbSDimitry Andric !std::is_constructible<StringRef, UnaryFunctor>::value && 18235ffd83dbSDimitry Andric !std::is_constructible<StringRef, NullaryFunctor>::value>::type> 18245ffd83dbSDimitry Andric inline void interleave(ForwardIterator begin, ForwardIterator end, 18255ffd83dbSDimitry Andric UnaryFunctor each_fn, NullaryFunctor between_fn) { 18265ffd83dbSDimitry Andric if (begin == end) 18275ffd83dbSDimitry Andric return; 18285ffd83dbSDimitry Andric each_fn(*begin); 18295ffd83dbSDimitry Andric ++begin; 18305ffd83dbSDimitry Andric for (; begin != end; ++begin) { 18315ffd83dbSDimitry Andric between_fn(); 18325ffd83dbSDimitry Andric each_fn(*begin); 18335ffd83dbSDimitry Andric } 18345ffd83dbSDimitry Andric } 18355ffd83dbSDimitry Andric 18365ffd83dbSDimitry Andric template <typename Container, typename UnaryFunctor, typename NullaryFunctor, 18375ffd83dbSDimitry Andric typename = typename std::enable_if< 18385ffd83dbSDimitry Andric !std::is_constructible<StringRef, UnaryFunctor>::value && 18395ffd83dbSDimitry Andric !std::is_constructible<StringRef, NullaryFunctor>::value>::type> 18405ffd83dbSDimitry Andric inline void interleave(const Container &c, UnaryFunctor each_fn, 18415ffd83dbSDimitry Andric NullaryFunctor between_fn) { 18425ffd83dbSDimitry Andric interleave(c.begin(), c.end(), each_fn, between_fn); 18435ffd83dbSDimitry Andric } 18445ffd83dbSDimitry Andric 18455ffd83dbSDimitry Andric /// Overload of interleave for the common case of string separator. 18465ffd83dbSDimitry Andric template <typename Container, typename UnaryFunctor, typename StreamT, 18475ffd83dbSDimitry Andric typename T = detail::ValueOfRange<Container>> 18485ffd83dbSDimitry Andric inline void interleave(const Container &c, StreamT &os, UnaryFunctor each_fn, 18495ffd83dbSDimitry Andric const StringRef &separator) { 18505ffd83dbSDimitry Andric interleave(c.begin(), c.end(), each_fn, [&] { os << separator; }); 18515ffd83dbSDimitry Andric } 18525ffd83dbSDimitry Andric template <typename Container, typename StreamT, 18535ffd83dbSDimitry Andric typename T = detail::ValueOfRange<Container>> 18545ffd83dbSDimitry Andric inline void interleave(const Container &c, StreamT &os, 18555ffd83dbSDimitry Andric const StringRef &separator) { 18565ffd83dbSDimitry Andric interleave( 18575ffd83dbSDimitry Andric c, os, [&](const T &a) { os << a; }, separator); 18585ffd83dbSDimitry Andric } 18595ffd83dbSDimitry Andric 18605ffd83dbSDimitry Andric template <typename Container, typename UnaryFunctor, typename StreamT, 18615ffd83dbSDimitry Andric typename T = detail::ValueOfRange<Container>> 18625ffd83dbSDimitry Andric inline void interleaveComma(const Container &c, StreamT &os, 18635ffd83dbSDimitry Andric UnaryFunctor each_fn) { 18645ffd83dbSDimitry Andric interleave(c, os, each_fn, ", "); 18655ffd83dbSDimitry Andric } 18665ffd83dbSDimitry Andric template <typename Container, typename StreamT, 18675ffd83dbSDimitry Andric typename T = detail::ValueOfRange<Container>> 18685ffd83dbSDimitry Andric inline void interleaveComma(const Container &c, StreamT &os) { 18695ffd83dbSDimitry Andric interleaveComma(c, os, [&](const T &a) { os << a; }); 18705ffd83dbSDimitry Andric } 18715ffd83dbSDimitry Andric 18720b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 18730b57cec5SDimitry Andric // Extra additions to <memory> 18740b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 18750b57cec5SDimitry Andric 18760b57cec5SDimitry Andric struct FreeDeleter { 18770b57cec5SDimitry Andric void operator()(void* v) { 18780b57cec5SDimitry Andric ::free(v); 18790b57cec5SDimitry Andric } 18800b57cec5SDimitry Andric }; 18810b57cec5SDimitry Andric 18820b57cec5SDimitry Andric template<typename First, typename Second> 18830b57cec5SDimitry Andric struct pair_hash { 18840b57cec5SDimitry Andric size_t operator()(const std::pair<First, Second> &P) const { 18850b57cec5SDimitry Andric return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second); 18860b57cec5SDimitry Andric } 18870b57cec5SDimitry Andric }; 18880b57cec5SDimitry Andric 18890b57cec5SDimitry Andric /// Binary functor that adapts to any other binary functor after dereferencing 18900b57cec5SDimitry Andric /// operands. 18910b57cec5SDimitry Andric template <typename T> struct deref { 18920b57cec5SDimitry Andric T func; 18930b57cec5SDimitry Andric 18940b57cec5SDimitry Andric // Could be further improved to cope with non-derivable functors and 18950b57cec5SDimitry Andric // non-binary functors (should be a variadic template member function 18960b57cec5SDimitry Andric // operator()). 18975ffd83dbSDimitry Andric template <typename A, typename B> auto operator()(A &lhs, B &rhs) const { 18980b57cec5SDimitry Andric assert(lhs); 18990b57cec5SDimitry Andric assert(rhs); 19000b57cec5SDimitry Andric return func(*lhs, *rhs); 19010b57cec5SDimitry Andric } 19020b57cec5SDimitry Andric }; 19030b57cec5SDimitry Andric 19040b57cec5SDimitry Andric namespace detail { 19050b57cec5SDimitry Andric 19060b57cec5SDimitry Andric template <typename R> class enumerator_iter; 19070b57cec5SDimitry Andric 19080b57cec5SDimitry Andric template <typename R> struct result_pair { 19090b57cec5SDimitry Andric using value_reference = 19100b57cec5SDimitry Andric typename std::iterator_traits<IterOfRange<R>>::reference; 19110b57cec5SDimitry Andric 19120b57cec5SDimitry Andric friend class enumerator_iter<R>; 19130b57cec5SDimitry Andric 19140b57cec5SDimitry Andric result_pair() = default; 19150b57cec5SDimitry Andric result_pair(std::size_t Index, IterOfRange<R> Iter) 19160b57cec5SDimitry Andric : Index(Index), Iter(Iter) {} 19170b57cec5SDimitry Andric 1918fe6060f1SDimitry Andric result_pair(const result_pair<R> &Other) 1919480093f4SDimitry Andric : Index(Other.Index), Iter(Other.Iter) {} 1920fe6060f1SDimitry Andric result_pair &operator=(const result_pair &Other) { 19210b57cec5SDimitry Andric Index = Other.Index; 19220b57cec5SDimitry Andric Iter = Other.Iter; 19230b57cec5SDimitry Andric return *this; 19240b57cec5SDimitry Andric } 19250b57cec5SDimitry Andric 19260b57cec5SDimitry Andric std::size_t index() const { return Index; } 1927*349cc55cSDimitry Andric value_reference value() const { return *Iter; } 19280b57cec5SDimitry Andric 19290b57cec5SDimitry Andric private: 19300b57cec5SDimitry Andric std::size_t Index = std::numeric_limits<std::size_t>::max(); 19310b57cec5SDimitry Andric IterOfRange<R> Iter; 19320b57cec5SDimitry Andric }; 19330b57cec5SDimitry Andric 19340b57cec5SDimitry Andric template <typename R> 19350b57cec5SDimitry Andric class enumerator_iter 1936*349cc55cSDimitry Andric : public iterator_facade_base<enumerator_iter<R>, std::forward_iterator_tag, 1937*349cc55cSDimitry Andric const result_pair<R>> { 19380b57cec5SDimitry Andric using result_type = result_pair<R>; 19390b57cec5SDimitry Andric 19400b57cec5SDimitry Andric public: 19410b57cec5SDimitry Andric explicit enumerator_iter(IterOfRange<R> EndIter) 19420b57cec5SDimitry Andric : Result(std::numeric_limits<size_t>::max(), EndIter) {} 19430b57cec5SDimitry Andric 19440b57cec5SDimitry Andric enumerator_iter(std::size_t Index, IterOfRange<R> Iter) 19450b57cec5SDimitry Andric : Result(Index, Iter) {} 19460b57cec5SDimitry Andric 19470b57cec5SDimitry Andric const result_type &operator*() const { return Result; } 19480b57cec5SDimitry Andric 1949fe6060f1SDimitry Andric enumerator_iter &operator++() { 19500b57cec5SDimitry Andric assert(Result.Index != std::numeric_limits<size_t>::max()); 19510b57cec5SDimitry Andric ++Result.Iter; 19520b57cec5SDimitry Andric ++Result.Index; 19530b57cec5SDimitry Andric return *this; 19540b57cec5SDimitry Andric } 19550b57cec5SDimitry Andric 1956fe6060f1SDimitry Andric bool operator==(const enumerator_iter &RHS) const { 19570b57cec5SDimitry Andric // Don't compare indices here, only iterators. It's possible for an end 19580b57cec5SDimitry Andric // iterator to have different indices depending on whether it was created 19590b57cec5SDimitry Andric // by calling std::end() versus incrementing a valid iterator. 19600b57cec5SDimitry Andric return Result.Iter == RHS.Result.Iter; 19610b57cec5SDimitry Andric } 19620b57cec5SDimitry Andric 1963fe6060f1SDimitry Andric enumerator_iter(const enumerator_iter &Other) : Result(Other.Result) {} 1964fe6060f1SDimitry Andric enumerator_iter &operator=(const enumerator_iter &Other) { 19650b57cec5SDimitry Andric Result = Other.Result; 19660b57cec5SDimitry Andric return *this; 19670b57cec5SDimitry Andric } 19680b57cec5SDimitry Andric 19690b57cec5SDimitry Andric private: 19700b57cec5SDimitry Andric result_type Result; 19710b57cec5SDimitry Andric }; 19720b57cec5SDimitry Andric 19730b57cec5SDimitry Andric template <typename R> class enumerator { 19740b57cec5SDimitry Andric public: 19750b57cec5SDimitry Andric explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {} 19760b57cec5SDimitry Andric 19770b57cec5SDimitry Andric enumerator_iter<R> begin() { 19780b57cec5SDimitry Andric return enumerator_iter<R>(0, std::begin(TheRange)); 19790b57cec5SDimitry Andric } 19800b57cec5SDimitry Andric 19810b57cec5SDimitry Andric enumerator_iter<R> end() { 19820b57cec5SDimitry Andric return enumerator_iter<R>(std::end(TheRange)); 19830b57cec5SDimitry Andric } 19840b57cec5SDimitry Andric 19850b57cec5SDimitry Andric private: 19860b57cec5SDimitry Andric R TheRange; 19870b57cec5SDimitry Andric }; 19880b57cec5SDimitry Andric 19890b57cec5SDimitry Andric } // end namespace detail 19900b57cec5SDimitry Andric 19910b57cec5SDimitry Andric /// Given an input range, returns a new range whose values are are pair (A,B) 19920b57cec5SDimitry Andric /// such that A is the 0-based index of the item in the sequence, and B is 19930b57cec5SDimitry Andric /// the value from the original sequence. Example: 19940b57cec5SDimitry Andric /// 19950b57cec5SDimitry Andric /// std::vector<char> Items = {'A', 'B', 'C', 'D'}; 19960b57cec5SDimitry Andric /// for (auto X : enumerate(Items)) { 19970b57cec5SDimitry Andric /// printf("Item %d - %c\n", X.index(), X.value()); 19980b57cec5SDimitry Andric /// } 19990b57cec5SDimitry Andric /// 20000b57cec5SDimitry Andric /// Output: 20010b57cec5SDimitry Andric /// Item 0 - A 20020b57cec5SDimitry Andric /// Item 1 - B 20030b57cec5SDimitry Andric /// Item 2 - C 20040b57cec5SDimitry Andric /// Item 3 - D 20050b57cec5SDimitry Andric /// 20060b57cec5SDimitry Andric template <typename R> detail::enumerator<R> enumerate(R &&TheRange) { 20070b57cec5SDimitry Andric return detail::enumerator<R>(std::forward<R>(TheRange)); 20080b57cec5SDimitry Andric } 20090b57cec5SDimitry Andric 20100b57cec5SDimitry Andric namespace detail { 20110b57cec5SDimitry Andric 20120b57cec5SDimitry Andric template <typename F, typename Tuple, std::size_t... I> 20135ffd83dbSDimitry Andric decltype(auto) apply_tuple_impl(F &&f, Tuple &&t, std::index_sequence<I...>) { 20140b57cec5SDimitry Andric return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...); 20150b57cec5SDimitry Andric } 20160b57cec5SDimitry Andric 20170b57cec5SDimitry Andric } // end namespace detail 20180b57cec5SDimitry Andric 20190b57cec5SDimitry Andric /// Given an input tuple (a1, a2, ..., an), pass the arguments of the 20200b57cec5SDimitry Andric /// tuple variadically to f as if by calling f(a1, a2, ..., an) and 20210b57cec5SDimitry Andric /// return the result. 20220b57cec5SDimitry Andric template <typename F, typename Tuple> 20235ffd83dbSDimitry Andric decltype(auto) apply_tuple(F &&f, Tuple &&t) { 20248bcb0991SDimitry Andric using Indices = std::make_index_sequence< 20250b57cec5SDimitry Andric std::tuple_size<typename std::decay<Tuple>::type>::value>; 20260b57cec5SDimitry Andric 20270b57cec5SDimitry Andric return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t), 20280b57cec5SDimitry Andric Indices{}); 20290b57cec5SDimitry Andric } 20300b57cec5SDimitry Andric 2031*349cc55cSDimitry Andric namespace detail { 2032*349cc55cSDimitry Andric 2033*349cc55cSDimitry Andric template <typename Predicate, typename... Args> 2034*349cc55cSDimitry Andric bool all_of_zip_predicate_first(Predicate &&P, Args &&...args) { 2035*349cc55cSDimitry Andric auto z = zip(args...); 2036*349cc55cSDimitry Andric auto it = z.begin(); 2037*349cc55cSDimitry Andric auto end = z.end(); 2038*349cc55cSDimitry Andric while (it != end) { 2039*349cc55cSDimitry Andric if (!apply_tuple([&](auto &&...args) { return P(args...); }, *it)) 2040*349cc55cSDimitry Andric return false; 2041*349cc55cSDimitry Andric ++it; 2042*349cc55cSDimitry Andric } 2043*349cc55cSDimitry Andric return it.all_equals(end); 2044*349cc55cSDimitry Andric } 2045*349cc55cSDimitry Andric 2046*349cc55cSDimitry Andric // Just an adaptor to switch the order of argument and have the predicate before 2047*349cc55cSDimitry Andric // the zipped inputs. 2048*349cc55cSDimitry Andric template <typename... ArgsThenPredicate, size_t... InputIndexes> 2049*349cc55cSDimitry Andric bool all_of_zip_predicate_last( 2050*349cc55cSDimitry Andric std::tuple<ArgsThenPredicate...> argsThenPredicate, 2051*349cc55cSDimitry Andric std::index_sequence<InputIndexes...>) { 2052*349cc55cSDimitry Andric auto constexpr OutputIndex = 2053*349cc55cSDimitry Andric std::tuple_size<decltype(argsThenPredicate)>::value - 1; 2054*349cc55cSDimitry Andric return all_of_zip_predicate_first(std::get<OutputIndex>(argsThenPredicate), 2055*349cc55cSDimitry Andric std::get<InputIndexes>(argsThenPredicate)...); 2056*349cc55cSDimitry Andric } 2057*349cc55cSDimitry Andric 2058*349cc55cSDimitry Andric } // end namespace detail 2059*349cc55cSDimitry Andric 2060*349cc55cSDimitry Andric /// Compare two zipped ranges using the provided predicate (as last argument). 2061*349cc55cSDimitry Andric /// Return true if all elements satisfy the predicate and false otherwise. 2062*349cc55cSDimitry Andric // Return false if the zipped iterator aren't all at end (size mismatch). 2063*349cc55cSDimitry Andric template <typename... ArgsAndPredicate> 2064*349cc55cSDimitry Andric bool all_of_zip(ArgsAndPredicate &&...argsAndPredicate) { 2065*349cc55cSDimitry Andric return detail::all_of_zip_predicate_last( 2066*349cc55cSDimitry Andric std::forward_as_tuple(argsAndPredicate...), 2067*349cc55cSDimitry Andric std::make_index_sequence<sizeof...(argsAndPredicate) - 1>{}); 2068*349cc55cSDimitry Andric } 2069*349cc55cSDimitry Andric 20700b57cec5SDimitry Andric /// Return true if the sequence [Begin, End) has exactly N items. Runs in O(N) 20710b57cec5SDimitry Andric /// time. Not meant for use with random-access iterators. 20725ffd83dbSDimitry Andric /// Can optionally take a predicate to filter lazily some items. 20735ffd83dbSDimitry Andric template <typename IterTy, 20745ffd83dbSDimitry Andric typename Pred = bool (*)(const decltype(*std::declval<IterTy>()) &)> 20750b57cec5SDimitry Andric bool hasNItems( 20760b57cec5SDimitry Andric IterTy &&Begin, IterTy &&End, unsigned N, 20775ffd83dbSDimitry Andric Pred &&ShouldBeCounted = 20785ffd83dbSDimitry Andric [](const decltype(*std::declval<IterTy>()) &) { return true; }, 20795ffd83dbSDimitry Andric std::enable_if_t< 2080e8d8bef9SDimitry Andric !std::is_base_of<std::random_access_iterator_tag, 2081e8d8bef9SDimitry Andric typename std::iterator_traits<std::remove_reference_t< 2082e8d8bef9SDimitry Andric decltype(Begin)>>::iterator_category>::value, 20835ffd83dbSDimitry Andric void> * = nullptr) { 20845ffd83dbSDimitry Andric for (; N; ++Begin) { 20850b57cec5SDimitry Andric if (Begin == End) 20860b57cec5SDimitry Andric return false; // Too few. 20875ffd83dbSDimitry Andric N -= ShouldBeCounted(*Begin); 20885ffd83dbSDimitry Andric } 20895ffd83dbSDimitry Andric for (; Begin != End; ++Begin) 20905ffd83dbSDimitry Andric if (ShouldBeCounted(*Begin)) 20915ffd83dbSDimitry Andric return false; // Too many. 20925ffd83dbSDimitry Andric return true; 20930b57cec5SDimitry Andric } 20940b57cec5SDimitry Andric 20950b57cec5SDimitry Andric /// Return true if the sequence [Begin, End) has N or more items. Runs in O(N) 20960b57cec5SDimitry Andric /// time. Not meant for use with random-access iterators. 20975ffd83dbSDimitry Andric /// Can optionally take a predicate to lazily filter some items. 20985ffd83dbSDimitry Andric template <typename IterTy, 20995ffd83dbSDimitry Andric typename Pred = bool (*)(const decltype(*std::declval<IterTy>()) &)> 21000b57cec5SDimitry Andric bool hasNItemsOrMore( 21010b57cec5SDimitry Andric IterTy &&Begin, IterTy &&End, unsigned N, 21025ffd83dbSDimitry Andric Pred &&ShouldBeCounted = 21035ffd83dbSDimitry Andric [](const decltype(*std::declval<IterTy>()) &) { return true; }, 21045ffd83dbSDimitry Andric std::enable_if_t< 2105e8d8bef9SDimitry Andric !std::is_base_of<std::random_access_iterator_tag, 2106e8d8bef9SDimitry Andric typename std::iterator_traits<std::remove_reference_t< 2107e8d8bef9SDimitry Andric decltype(Begin)>>::iterator_category>::value, 21085ffd83dbSDimitry Andric void> * = nullptr) { 21095ffd83dbSDimitry Andric for (; N; ++Begin) { 21100b57cec5SDimitry Andric if (Begin == End) 21110b57cec5SDimitry Andric return false; // Too few. 21125ffd83dbSDimitry Andric N -= ShouldBeCounted(*Begin); 21135ffd83dbSDimitry Andric } 21140b57cec5SDimitry Andric return true; 21150b57cec5SDimitry Andric } 21160b57cec5SDimitry Andric 21175ffd83dbSDimitry Andric /// Returns true if the sequence [Begin, End) has N or less items. Can 21185ffd83dbSDimitry Andric /// optionally take a predicate to lazily filter some items. 21195ffd83dbSDimitry Andric template <typename IterTy, 21205ffd83dbSDimitry Andric typename Pred = bool (*)(const decltype(*std::declval<IterTy>()) &)> 21215ffd83dbSDimitry Andric bool hasNItemsOrLess( 21225ffd83dbSDimitry Andric IterTy &&Begin, IterTy &&End, unsigned N, 21235ffd83dbSDimitry Andric Pred &&ShouldBeCounted = [](const decltype(*std::declval<IterTy>()) &) { 21245ffd83dbSDimitry Andric return true; 21255ffd83dbSDimitry Andric }) { 21265ffd83dbSDimitry Andric assert(N != std::numeric_limits<unsigned>::max()); 21275ffd83dbSDimitry Andric return !hasNItemsOrMore(Begin, End, N + 1, ShouldBeCounted); 21285ffd83dbSDimitry Andric } 21295ffd83dbSDimitry Andric 21305ffd83dbSDimitry Andric /// Returns true if the given container has exactly N items 21315ffd83dbSDimitry Andric template <typename ContainerTy> bool hasNItems(ContainerTy &&C, unsigned N) { 21325ffd83dbSDimitry Andric return hasNItems(std::begin(C), std::end(C), N); 21335ffd83dbSDimitry Andric } 21345ffd83dbSDimitry Andric 21355ffd83dbSDimitry Andric /// Returns true if the given container has N or more items 21365ffd83dbSDimitry Andric template <typename ContainerTy> 21375ffd83dbSDimitry Andric bool hasNItemsOrMore(ContainerTy &&C, unsigned N) { 21385ffd83dbSDimitry Andric return hasNItemsOrMore(std::begin(C), std::end(C), N); 21395ffd83dbSDimitry Andric } 21405ffd83dbSDimitry Andric 21415ffd83dbSDimitry Andric /// Returns true if the given container has N or less items 21425ffd83dbSDimitry Andric template <typename ContainerTy> 21435ffd83dbSDimitry Andric bool hasNItemsOrLess(ContainerTy &&C, unsigned N) { 21445ffd83dbSDimitry Andric return hasNItemsOrLess(std::begin(C), std::end(C), N); 21455ffd83dbSDimitry Andric } 21465ffd83dbSDimitry Andric 21470b57cec5SDimitry Andric /// Returns a raw pointer that represents the same address as the argument. 21480b57cec5SDimitry Andric /// 21495ffd83dbSDimitry Andric /// This implementation can be removed once we move to C++20 where it's defined 21505ffd83dbSDimitry Andric /// as std::to_address(). 21510b57cec5SDimitry Andric /// 21520b57cec5SDimitry Andric /// The std::pointer_traits<>::to_address(p) variations of these overloads has 21530b57cec5SDimitry Andric /// not been implemented. 21545ffd83dbSDimitry Andric template <class Ptr> auto to_address(const Ptr &P) { return P.operator->(); } 21550b57cec5SDimitry Andric template <class T> constexpr T *to_address(T *P) { return P; } 21560b57cec5SDimitry Andric 21570b57cec5SDimitry Andric } // end namespace llvm 21580b57cec5SDimitry Andric 21590b57cec5SDimitry Andric #endif // LLVM_ADT_STLEXTRAS_H 2160