Daily bump.
[gcc.git] / libstdc++-v3 / include / ext / pb_ds / detail / ov_tree_map_ / ov_tree_map_.hpp
index d6ba00b88565eb75c201a85e34dea89fe3b90c34..77522055a61929a30228cd655fe0f2c5ae592f83 100644 (file)
@@ -1,6 +1,6 @@
 // -*- C++ -*-
 
-// Copyright (C) 2005, 2006, 2009, 2011 Free Software Foundation, Inc.
+// Copyright (C) 2005-2021 Free Software Foundation, Inc.
 //
 // This file is part of the GNU ISO C++ Library.  This library is free
 // software; you can redistribute it and/or modify it under the terms
 // warranty.
 
 /**
- * @file ov_tree_map_.hpp
- * Contains an implementation class for ov_tree_.
+ * @file ov_tree_map_/ov_tree_map_.hpp
+ * Contains an implementation class for ov_tree.
  */
 
 #include <map>
 #include <set>
+#include <ext/pb_ds/exception.hpp>
 #include <ext/pb_ds/tree_policy.hpp>
 #include <ext/pb_ds/detail/eq_fn/eq_by_less.hpp>
 #include <ext/pb_ds/detail/types_traits.hpp>
-#include <ext/pb_ds/detail/debug_map_base.hpp>
 #include <ext/pb_ds/detail/type_utils.hpp>
-#include <ext/pb_ds/exception.hpp>
 #include <ext/pb_ds/detail/tree_trace_base.hpp>
+#ifdef _GLIBCXX_DEBUG
+#include <ext/pb_ds/detail/debug_map_base.hpp>
+#endif
 #include <utility>
 #include <functional>
 #include <algorithm>
@@ -58,165 +60,176 @@ namespace __gnu_pbds
 {
   namespace detail
   {
-#define PB_DS_CLASS_T_DEC \
-    template<typename Key, typename Mapped, class Cmp_Fn, \
-            class Node_And_It_Traits, class Allocator>
-
 #ifdef PB_DS_DATA_TRUE_INDICATOR
-#define PB_DS_OV_TREE_CLASS_NAME ov_tree_data_
-#endif 
+#define PB_DS_OV_TREE_NAME ov_tree_map
+#define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_node_const_iterator_map
+#endif
 
 #ifdef PB_DS_DATA_FALSE_INDICATOR
-#define PB_DS_OV_TREE_CLASS_NAME ov_tree_no_data_
-#endif 
+#define PB_DS_OV_TREE_NAME ov_tree_set
+#define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_node_const_iterator_set
+#endif
 
-#ifdef PB_DS_DATA_TRUE_INDICATOR
-#define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_const_node_iterator_data_
-#else 
-#define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_const_node_iterator_no_data_
-#endif 
+#define PB_DS_CLASS_T_DEC \
+    template<typename Key, typename Mapped, typename Cmp_Fn, \
+            typename Node_And_It_Traits, typename _Alloc>
 
 #define PB_DS_CLASS_C_DEC \
-   PB_DS_OV_TREE_CLASS_NAME<Key, Mapped, Cmp_Fn, Node_And_It_Traits, Allocator>
+   PB_DS_OV_TREE_NAME<Key, Mapped, Cmp_Fn, Node_And_It_Traits, _Alloc>
 
-#define PB_DS_TYPES_TRAITS_C_DEC \
-    types_traits<Key, Mapped, Allocator, false>
+#define PB_DS_OV_TREE_TRAITS_BASE \
+    types_traits<Key, Mapped, _Alloc, false>
 
 #ifdef _GLIBCXX_DEBUG
 #define PB_DS_DEBUG_MAP_BASE_C_DEC \
     debug_map_base<Key, eq_by_less<Key, Cmp_Fn>, \
-               typename Allocator::template rebind<Key>::other::const_reference>
-#endif 
-
-#ifdef PB_DS_DATA_TRUE_INDICATOR
-#define PB_DS_V2F(X) (X).first
-#define PB_DS_V2S(X) (X).second
-#define PB_DS_EP2VP(X)& ((X)->m_value)
-#endif 
-
-#ifdef PB_DS_DATA_FALSE_INDICATOR
-#define PB_DS_V2F(X) (X)
-#define PB_DS_V2S(X) Mapped_Data()
-#define PB_DS_EP2VP(X)& ((X)->m_value.first)
-#endif 
+                  typename rebind_traits<_Alloc, Key>::const_reference>
+#endif
 
 #ifdef PB_DS_TREE_TRACE
 #define PB_DS_TREE_TRACE_BASE_C_DEC \
-    tree_trace_base<typename Node_And_It_Traits::const_node_iterator,  \
+    tree_trace_base<typename Node_And_It_Traits::node_const_iterator,  \
                    typename Node_And_It_Traits::node_iterator,         \
-                   Cmp_Fn, false, Allocator>
+                   Cmp_Fn, false, _Alloc>
 #endif
 
-#define PB_DS_ASSERT_VALID(X)                                          \
-  _GLIBCXX_DEBUG_ONLY(X.assert_valid(__FILE__, __LINE__);)
-
-#define PB_DS_CHECK_KEY_EXISTS(_Key)                                   \
-  _GLIBCXX_DEBUG_ONLY(debug_base::check_key_exists(_Key, __FILE__, __LINE__);)
-
-#define PB_DS_CHECK_KEY_DOES_NOT_EXIST(_Key)                           \
-  _GLIBCXX_DEBUG_ONLY(debug_base::check_key_does_not_exist(_Key,       \
-                                                          __FILE__, __LINE__);)
+#ifndef PB_DS_CHECK_KEY_EXISTS
+#  error Missing definition
+#endif
 
-    // Ordered-vector tree associative-container.
-    template<typename Key, typename Mapped, class Cmp_Fn,
-            class Node_And_It_Traits, class Allocator>
-    class PB_DS_OV_TREE_CLASS_NAME :
+    /**
+     *  @brief Ordered-vector tree associative-container.
+     *  @ingroup branch-detail
+     */
+    template<typename Key, typename Mapped, typename Cmp_Fn,
+            typename Node_And_It_Traits, typename _Alloc>
+    class PB_DS_OV_TREE_NAME :
 #ifdef _GLIBCXX_DEBUG
       protected PB_DS_DEBUG_MAP_BASE_C_DEC,
-#endif 
+#endif
 #ifdef PB_DS_TREE_TRACE
       public PB_DS_TREE_TRACE_BASE_C_DEC,
-#endif 
+#endif
       public Cmp_Fn,
       public Node_And_It_Traits::node_update,
-      public PB_DS_TYPES_TRAITS_C_DEC
+      public PB_DS_OV_TREE_TRAITS_BASE
     {
     private:
-      typedef PB_DS_TYPES_TRAITS_C_DEC traits_base;
+      typedef PB_DS_OV_TREE_TRAITS_BASE                        traits_base;
+      typedef Node_And_It_Traits                       traits_type;
 
       typedef typename remove_const<typename traits_base::value_type>::type non_const_value_type;
 
-      typedef typename Allocator::template rebind<non_const_value_type>::other value_allocator;
-      typedef typename value_allocator::pointer value_vector;
-
-
-      typedef Cmp_Fn cmp_fn_base;
+      typedef rebind_traits<_Alloc, non_const_value_type> value_alloc_traits;
+      typedef typename value_alloc_traits::allocator_type value_allocator;
+      typedef typename value_alloc_traits::pointer       value_vector;
 
 #ifdef _GLIBCXX_DEBUG
-      typedef PB_DS_DEBUG_MAP_BASE_C_DEC debug_base;
-#endif 
+      typedef PB_DS_DEBUG_MAP_BASE_C_DEC               debug_base;
+#endif
+
+#ifdef PB_DS_TREE_TRACE
+      typedef PB_DS_TREE_TRACE_BASE_C_DEC              trace_base;
+#endif
 
-      typedef typename traits_base::pointer mapped_pointer_;
-      typedef typename traits_base::const_pointer const_mapped_pointer_;
+      typedef typename traits_base::pointer            mapped_pointer_;
+      typedef typename traits_base::const_pointer      mapped_const_pointer_;
 
-      typedef typename Node_And_It_Traits::metadata_type metadata_type;
+      typedef typename traits_type::metadata_type      metadata_type;
 
-      typedef typename Allocator::template rebind<metadata_type>::other metadata_allocator;
-      typedef typename metadata_allocator::pointer metadata_pointer;
-      typedef typename metadata_allocator::const_reference const_metadata_reference;
-      typedef typename metadata_allocator::reference metadata_reference;
+      typedef rebind_traits<_Alloc, metadata_type>     metadata_alloc_traits;
+      typedef typename metadata_alloc_traits::allocator_type metadata_allocator;
+      typedef typename metadata_alloc_traits::pointer  metadata_pointer;
+      typedef typename metadata_alloc_traits::const_reference metadata_const_reference;
+      typedef typename metadata_alloc_traits::reference        metadata_reference;
 
-      typedef
-      typename Node_And_It_Traits::null_node_update_pointer
+      typedef typename traits_type::null_node_update_pointer
       null_node_update_pointer;
 
     public:
-
-      typedef Allocator allocator_type;
-      typedef typename Allocator::size_type size_type;
-      typedef typename Allocator::difference_type difference_type;
-
-      typedef Cmp_Fn cmp_fn;
-
-      typedef typename Node_And_It_Traits::node_update node_update;
-
-      typedef typename traits_base::key_type key_type;
-      typedef typename traits_base::key_pointer key_pointer;
-      typedef typename traits_base::const_key_pointer const_key_pointer;
-      typedef typename traits_base::key_reference key_reference;
-      typedef typename traits_base::const_key_reference const_key_reference;
-      typedef typename traits_base::mapped_type mapped_type;
-      typedef typename traits_base::mapped_pointer mapped_pointer;
-      typedef typename traits_base::const_mapped_pointer const_mapped_pointer;
-      typedef typename traits_base::mapped_reference mapped_reference;
-      typedef typename traits_base::const_mapped_reference const_mapped_reference;
-      typedef typename traits_base::value_type value_type;
-      typedef typename traits_base::pointer pointer;
-      typedef typename traits_base::const_pointer const_pointer;
-      typedef typename traits_base::reference reference;
-      typedef typename traits_base::const_reference const_reference;
-
-      typedef const_pointer const_point_iterator;
-
+      typedef ov_tree_tag                              container_category;
+      typedef _Alloc                                   allocator_type;
+      typedef typename _Alloc::size_type               size_type;
+      typedef typename _Alloc::difference_type                 difference_type;
+      typedef Cmp_Fn                                   cmp_fn;
+
+      typedef typename traits_base::key_type           key_type;
+      typedef typename traits_base::key_pointer        key_pointer;
+      typedef typename traits_base::key_const_pointer  key_const_pointer;
+      typedef typename traits_base::key_reference      key_reference;
+      typedef typename traits_base::key_const_reference key_const_reference;
+      typedef typename traits_base::mapped_type        mapped_type;
+      typedef typename traits_base::mapped_pointer     mapped_pointer;
+      typedef typename traits_base::mapped_const_pointer mapped_const_pointer;
+      typedef typename traits_base::mapped_reference   mapped_reference;
+      typedef typename traits_base::mapped_const_reference mapped_const_reference;
+      typedef typename traits_base::value_type                 value_type;
+      typedef typename traits_base::pointer            pointer;
+      typedef typename traits_base::const_pointer      const_pointer;
+      typedef typename traits_base::reference          reference;
+      typedef typename traits_base::const_reference    const_reference;
+
+      typedef const_pointer                            point_const_iterator;
 #ifdef PB_DS_DATA_TRUE_INDICATOR
-      typedef pointer point_iterator;
-#else 
-      typedef const_point_iterator point_iterator;
-#endif 
-
-      typedef const_point_iterator const_iterator;
-
-      typedef point_iterator iterator;
-
-#include <ext/pb_ds/detail/ov_tree_map_/cond_dtor.hpp>
+      typedef pointer                                  point_iterator;
+#else
+      typedef point_const_iterator                     point_iterator;
+#endif
 
-      typedef
-      typename Node_And_It_Traits::const_node_iterator
-      const_node_iterator;
+      typedef point_iterator                           iterator;
+      typedef point_const_iterator                     const_iterator;
+
+      /// Conditional destructor.
+      template<typename Size_Type>
+        class cond_dtor
+        {
+       public:
+         cond_dtor(value_vector a_vec, iterator& r_last_it, 
+                   Size_Type total_size) 
+         : m_a_vec(a_vec), m_r_last_it(r_last_it), m_max_size(total_size),
+           m_no_action(false)
+         { }
+
+         ~cond_dtor()
+         {
+           if (m_no_action)
+             return;
+           iterator it = m_a_vec;
+           while (it != m_r_last_it)
+             {
+               it->~value_type();
+               ++it;
+             }
+           
+           if (m_max_size > 0)
+             value_allocator().deallocate(m_a_vec, m_max_size);
+         }
 
-      typedef typename Node_And_It_Traits::node_iterator node_iterator;
+         inline void
+         set_no_action()
+         { m_no_action = true; }
+         
+       protected:
+         value_vector          m_a_vec;
+         iterator&             m_r_last_it;
+         const Size_Type       m_max_size;
+         bool                  m_no_action;
+       };
+      
+      typedef typename traits_type::node_update        node_update;
+      typedef typename traits_type::node_iterator      node_iterator;
+      typedef typename traits_type::node_const_iterator        node_const_iterator;
 
-    public:
 
-      PB_DS_OV_TREE_CLASS_NAME();
+      PB_DS_OV_TREE_NAME();
 
-      PB_DS_OV_TREE_CLASS_NAME(const Cmp_Fn&);
+      PB_DS_OV_TREE_NAME(const Cmp_Fn&);
 
-      PB_DS_OV_TREE_CLASS_NAME(const Cmp_Fn&, const node_update&);
+      PB_DS_OV_TREE_NAME(const Cmp_Fn&, const node_update&);
 
-      PB_DS_OV_TREE_CLASS_NAME(const PB_DS_CLASS_C_DEC&);
+      PB_DS_OV_TREE_NAME(const PB_DS_CLASS_C_DEC&);
 
-      ~PB_DS_OV_TREE_CLASS_NAME();
+      ~PB_DS_OV_TREE_NAME();
 
       void
       swap(PB_DS_CLASS_C_DEC&);
@@ -228,20 +241,20 @@ namespace __gnu_pbds
       inline size_type
       max_size() const;
 
-      inline bool
+      _GLIBCXX_NODISCARD inline bool
       empty() const;
 
       inline size_type
       size() const;
 
-      Cmp_Fn& 
+      Cmp_Fn&
       get_cmp_fn();
 
-      const Cmp_Fn& 
+      const Cmp_Fn&
       get_cmp_fn() const;
 
       inline mapped_reference
-      operator[](const_key_reference r_key)
+      operator[](key_const_reference r_key)
       {
 #ifdef PB_DS_DATA_TRUE_INDICATOR
        PB_DS_ASSERT_VALID((*this))
@@ -252,19 +265,18 @@ namespace __gnu_pbds
            PB_DS_ASSERT_VALID((*this))
             return it->second;
          }
-
-       return (insert_new_val(it, std::make_pair(r_key, mapped_type()))->second);
-#else 
+       return insert_new_val(it, std::make_pair(r_key, mapped_type()))->second;
+#else
        insert(r_key);
-       return traits_base::s_null_mapped;
-#endif 
+       return traits_base::s_null_type;
+#endif
       }
 
       inline std::pair<point_iterator, bool>
       insert(const_reference r_value)
       {
        PB_DS_ASSERT_VALID((*this))
-       const_key_reference r_key = PB_DS_V2F(r_value);
+       key_const_reference r_key = PB_DS_V2F(r_value);
        point_iterator it = lower_bound(r_key);
 
        if (it != end()&&  !Cmp_Fn::operator()(r_key, PB_DS_V2F(*it)))
@@ -278,14 +290,14 @@ namespace __gnu_pbds
       }
 
       inline point_iterator
-      lower_bound(const_key_reference r_key)
+      lower_bound(key_const_reference r_key)
       {
        pointer it = m_a_values;
        pointer e_it = m_a_values + m_size;
        while (it != e_it)
          {
            pointer mid_it = it + ((e_it - it) >> 1);
-           if (cmp_fn_base::operator()(PB_DS_V2F(*mid_it), r_key))
+           if (cmp_fn::operator()(PB_DS_V2F(*mid_it), r_key))
              it = ++mid_it;
            else
              e_it = mid_it;
@@ -293,15 +305,15 @@ namespace __gnu_pbds
        return it;
       }
 
-      inline const_point_iterator
-      lower_bound(const_key_reference r_key) const
+      inline point_const_iterator
+      lower_bound(key_const_reference r_key) const
       { return const_cast<PB_DS_CLASS_C_DEC& >(*this).lower_bound(r_key); }
 
       inline point_iterator
-      upper_bound(const_key_reference r_key)
+      upper_bound(key_const_reference r_key)
       {
        iterator pot_it = lower_bound(r_key);
-       if (pot_it != end()&&  !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
+       if (pot_it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
          {
            PB_DS_CHECK_KEY_EXISTS(r_key)
            return ++pot_it;
@@ -311,12 +323,12 @@ namespace __gnu_pbds
        return pot_it;
       }
 
-      inline const_point_iterator
-      upper_bound(const_key_reference r_key) const
+      inline point_const_iterator
+      upper_bound(key_const_reference r_key) const
       { return const_cast<PB_DS_CLASS_C_DEC&>(*this).upper_bound(r_key); }
 
       inline point_iterator
-      find(const_key_reference r_key)
+      find(key_const_reference r_key)
       {
        PB_DS_ASSERT_VALID((*this))
        iterator pot_it = lower_bound(r_key);
@@ -330,12 +342,12 @@ namespace __gnu_pbds
        return end();
       }
 
-      inline const_point_iterator
-      find(const_key_reference r_key) const
-      { return (const_cast<PB_DS_CLASS_C_DEC& >(*this).find(r_key)); }
+      inline point_const_iterator
+      find(key_const_reference r_key) const
+      { return (const_cast<PB_DS_CLASS_C_DEC&>(*this).find(r_key)); }
 
       bool
-      erase(const_key_reference);
+      erase(key_const_reference);
 
       template<typename Pred>
       inline size_type
@@ -352,7 +364,7 @@ namespace __gnu_pbds
       join(PB_DS_CLASS_C_DEC&);
 
       void
-      split(const_key_reference, PB_DS_CLASS_C_DEC&);
+      split(key_const_reference, PB_DS_CLASS_C_DEC&);
 
       inline iterator
       begin()
@@ -370,22 +382,30 @@ namespace __gnu_pbds
       end() const
       { return m_end_it; }
 
-      inline const_node_iterator
+      /// Returns a const node_iterator corresponding to the node at the
+      /// root of the tree.
+      inline node_const_iterator
       node_begin() const;
 
-      inline const_node_iterator
-      node_end() const;
-
+      /// Returns a node_iterator corresponding to the node at the
+      /// root of the tree.
       inline node_iterator
       node_begin();
 
+      /// Returns a const node_iterator corresponding to a node just
+      /// after a leaf of the tree.
+      inline node_const_iterator
+      node_end() const;
+
+      /// Returns a node_iterator corresponding to a node just
+      /// after a leaf of the tree.
       inline node_iterator
       node_end();
 
     private:
 
       inline void
-      update(node_iterator /*it*/, null_node_update_pointer);
+      update(node_iterator, null_node_update_pointer);
 
       template<typename Node_Update>
       void
@@ -421,8 +441,8 @@ namespace __gnu_pbds
       insert_new_val(iterator it, const_reference r_value)
       {
 #ifdef PB_DS_REGRESSION
-         typename Allocator::group_adjustor adjust(m_size);
-#endif 
+       typename _Alloc::group_adjustor adjust(m_size);
+#endif
 
        PB_DS_CHECK_KEY_DOES_NOT_EXIST(PB_DS_V2F(r_value))
 
@@ -436,23 +456,23 @@ namespace __gnu_pbds
        cond_dtor<size_type> cd(a_values, target_it, m_size + 1);
        while (source_it != it)
          {
-           new (const_cast<void* >(static_cast<const void* >(target_it)))
+           new (const_cast<void*>(static_cast<const void*>(target_it)))
              value_type(*source_it++);
            ++target_it;
          }
 
-       new (const_cast<void* >(static_cast<const void* >(ret_it = target_it)))
+       new (const_cast<void*>(static_cast<const void*>(ret_it = target_it)))
          value_type(r_value);
        ++target_it;
 
        while (source_it != source_end_it)
          {
-           new (const_cast<void* >(static_cast<const void* >(target_it)))
+           new (const_cast<void*>(static_cast<const void*>(target_it)))
              value_type(*source_it++);
            ++target_it;
          }
 
-       reallocate_metadata((node_update* )this, m_size + 1);
+       reallocate_metadata((node_update*)this, m_size + 1);
        cd.set_no_action();
        if (m_size != 0)
          {
@@ -470,20 +490,20 @@ namespace __gnu_pbds
 
 #ifdef _GLIBCXX_DEBUG
       void
-      assert_valid(const char* file, int line) const;
+      assert_valid(const char*, int) const;
 
       void
-      assert_iterators(const char* file, int line) const;
-#endif 
+      assert_iterators(const char*, int) const;
+#endif
 
       template<typename It>
       It
-      erase_imp(It it);
+      erase_imp(It);
 
-      inline const_node_iterator
+      inline node_const_iterator
       PB_DS_node_begin_imp() const;
 
-      inline const_node_iterator
+      inline node_const_iterator
       PB_DS_node_end_imp() const;
 
       inline node_iterator
@@ -493,21 +513,15 @@ namespace __gnu_pbds
       PB_DS_node_end_imp();
 
     private:
-      static value_allocator s_value_alloc;
+      static value_allocator   s_value_alloc;
       static metadata_allocator s_metadata_alloc;
 
-      value_vector m_a_values;
-      metadata_pointer m_a_metadata;
-      iterator m_end_it;
-      size_type m_size;
+      value_vector             m_a_values;
+      metadata_pointer                 m_a_metadata;
+      iterator                         m_end_it;
+      size_type                m_size;
     };
 
-#define PB_DS_DEBUG_VERIFY(_Cond)                                      \
-  _GLIBCXX_DEBUG_VERIFY_AT(_Cond,                                      \
-                          _M_message(#_Cond" assertion from %1;:%2;")  \
-                          ._M_string(__FILE__)._M_integer(__LINE__)    \
-                          ,__file,__line)
-
 #include <ext/pb_ds/detail/ov_tree_map_/constructors_destructor_fn_imps.hpp>
 #include <ext/pb_ds/detail/ov_tree_map_/iterators_fn_imps.hpp>
 #include <ext/pb_ds/detail/ov_tree_map_/debug_fn_imps.hpp>
@@ -517,23 +531,14 @@ namespace __gnu_pbds
 #include <ext/pb_ds/detail/ov_tree_map_/split_join_fn_imps.hpp>
 #include <ext/pb_ds/detail/bin_search_tree_/policy_access_fn_imps.hpp>
 
-#undef PB_DS_DEBUG_VERIFY
-#undef PB_DS_CHECK_KEY_DOES_NOT_EXIST
-#undef PB_DS_CHECK_KEY_EXISTS
-#undef PB_DS_ASSERT_VALID
 #undef PB_DS_CLASS_C_DEC
 #undef PB_DS_CLASS_T_DEC
-#undef PB_DS_OV_TREE_CLASS_NAME
-#undef PB_DS_TYPES_TRAITS_C_DEC
+#undef PB_DS_OV_TREE_NAME
+#undef PB_DS_OV_TREE_TRAITS_BASE
 #undef PB_DS_DEBUG_MAP_BASE_C_DEC
 #ifdef PB_DS_TREE_TRACE
 #undef PB_DS_TREE_TRACE_BASE_C_DEC
-#endif 
-
-#undef PB_DS_V2F
-#undef PB_DS_EP2VP
-#undef PB_DS_V2S
+#endif
 #undef PB_DS_CONST_NODE_ITERATOR_NAME
-
   } // namespace detail
 } // namespace __gnu_pbds