Fix decompression of truncated data
[folly.git] / folly / sorted_vector_types.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /*
18  * This header defines two classes that very nearly model
19  * AssociativeContainer (but not quite).  These implement set-like and
20  * map-like behavior on top of a sorted vector, instead of using
21  * rb-trees like std::set and std::map.
22  *
23  * This is potentially useful in cases where the number of elements in
24  * the set or map is small, or when you want to avoid using more
25  * memory than necessary and insertions/deletions are much more rare
26  * than lookups (these classes have O(N) insertions/deletions).
27  *
28  * In the interest of using these in conditions where the goal is to
29  * minimize memory usage, they support a GrowthPolicy parameter, which
30  * is a class defining a single function called increase_capacity,
31  * which will be called whenever we are about to insert something: you
32  * can then decide to call reserve() based on the current capacity()
33  * and size() of the passed in vector-esque Container type.  An
34  * example growth policy that grows one element at a time:
35  *
36  *    struct OneAtATimePolicy {
37  *      template<class Container>
38  *      void increase_capacity(Container& c) {
39  *        if (c.size() == c.capacity()) {
40  *          c.reserve(c.size() + 1);
41  *        }
42  *      }
43  *    };
44  *
45  *    typedef sorted_vector_set<int,
46  *                              std::less<int>,
47  *                              std::allocator<int>,
48  *                              OneAtATimePolicy>
49  *            OneAtATimeIntSet;
50  *
51  * Important differences from std::set and std::map:
52  *   - insert() and erase() invalidate iterators and references
53  *   - insert() and erase() are O(N)
54  *   - our iterators model RandomAccessIterator
55  *   - sorted_vector_map::value_type is pair<K,V>, not pair<const K,V>.
56  *     (This is basically because we want to store the value_type in
57  *     std::vector<>, which requires it to be Assignable.)
58  */
59
60 #pragma once
61
62 #include <algorithm>
63 #include <initializer_list>
64 #include <iterator>
65 #include <stdexcept>
66 #include <type_traits>
67 #include <utility>
68 #include <vector>
69
70 #include <boost/operators.hpp>
71 #include <folly/portability/BitsFunctexcept.h>
72
73 namespace folly {
74
75 //////////////////////////////////////////////////////////////////////
76
77 namespace detail {
78
79   // This wrapper goes around a GrowthPolicy and provides iterator
80   // preservation semantics, but only if the growth policy is not the
81   // default (i.e. nothing).
82   template<class Policy>
83   struct growth_policy_wrapper : private Policy {
84     template<class Container, class Iterator>
85     Iterator increase_capacity(Container& c, Iterator desired_insertion)
86     {
87       typedef typename Container::difference_type diff_t;
88       diff_t d = desired_insertion - c.begin();
89       Policy::increase_capacity(c);
90       return c.begin() + d;
91     }
92   };
93   template<>
94   struct growth_policy_wrapper<void> {
95     template<class Container, class Iterator>
96     Iterator increase_capacity(Container&, Iterator it) {
97       return it;
98     }
99   };
100
101   /*
102    * This helper returns the distance between two iterators if it is
103    * possible to figure it out without messing up the range
104    * (i.e. unless they are InputIterators).  Otherwise this returns
105    * -1.
106    */
107   template<class Iterator>
108   int distance_if_multipass(Iterator first, Iterator last) {
109     typedef typename std::iterator_traits<Iterator>::iterator_category categ;
110     if (std::is_same<categ,std::input_iterator_tag>::value)
111       return -1;
112     return std::distance(first, last);
113   }
114
115   template<class OurContainer, class Vector, class GrowthPolicy>
116   typename OurContainer::iterator
117   insert_with_hint(OurContainer& sorted,
118                    Vector& cont,
119                    typename OurContainer::iterator hint,
120                    typename OurContainer::value_type&& value,
121                    GrowthPolicy& po)
122   {
123     const typename OurContainer::value_compare& cmp(sorted.value_comp());
124     if (hint == cont.end() || cmp(value, *hint)) {
125       if (hint == cont.begin() || cmp(*(hint - 1), value)) {
126         hint = po.increase_capacity(cont, hint);
127         return cont.insert(hint, std::move(value));
128       } else {
129         return sorted.insert(std::move(value)).first;
130       }
131     }
132
133     if (cmp(*hint, value)) {
134       if (hint + 1 == cont.end() || cmp(value, *(hint + 1))) {
135         hint = po.increase_capacity(cont, hint + 1);
136         return cont.insert(hint, std::move(value));
137       } else {
138         return sorted.insert(std::move(value)).first;
139       }
140     }
141
142     // Value and *hint did not compare, so they are equal keys.
143     return hint;
144   }
145
146   template <class OurContainer, class Vector, class InputIterator>
147   void bulk_insert(
148       OurContainer& sorted,
149       Vector& cont,
150       InputIterator first,
151       InputIterator last) {
152     // prevent deref of middle where middle == cont.end()
153     if (first == last) {
154       return;
155     }
156
157     auto const& cmp(sorted.value_comp());
158
159     int const d = distance_if_multipass(first, last);
160     if (d != -1) {
161       cont.reserve(cont.size() + d);
162     }
163     auto const prev_size = cont.size();
164
165     std::copy(first, last, std::back_inserter(cont));
166     auto const middle = cont.begin() + prev_size;
167     if (!std::is_sorted(middle, cont.end(), cmp)) {
168       std::sort(middle, cont.end(), cmp);
169     }
170     if (middle != cont.begin() && cmp(*middle, *(middle - 1))) {
171       std::inplace_merge(cont.begin(), middle, cont.end(), cmp);
172       cont.erase(
173           std::unique(
174               cont.begin(),
175               cont.end(),
176               [&](typename OurContainer::value_type const& a,
177                   typename OurContainer::value_type const& b) {
178                 return !cmp(a, b) && !cmp(b, a);
179               }),
180           cont.end());
181     }
182   }
183 }
184
185 //////////////////////////////////////////////////////////////////////
186
187 /**
188  * A sorted_vector_set is a container similar to std::set<>, but
189  * implemented as as a sorted array with std::vector<>.
190  *
191  * @param class T               Data type to store
192  * @param class Compare         Comparison function that imposes a
193  *                              strict weak ordering over instances of T
194  * @param class Allocator       allocation policy
195  * @param class GrowthPolicy    policy object to control growth
196  *
197  * @author Aditya Agarwal <aditya@fb.com>
198  * @author Akhil Wable    <akhil@fb.com>
199  * @author Jordan DeLong  <delong.j@fb.com>
200  */
201 template<class T,
202          class Compare      = std::less<T>,
203          class Allocator    = std::allocator<T>,
204          class GrowthPolicy = void>
205 class sorted_vector_set
206   : boost::totally_ordered1<
207       sorted_vector_set<T,Compare,Allocator,GrowthPolicy>
208     , detail::growth_policy_wrapper<GrowthPolicy> >
209 {
210   typedef std::vector<T,Allocator> ContainerT;
211
212   detail::growth_policy_wrapper<GrowthPolicy>&
213   get_growth_policy() { return *this; }
214
215 public:
216   typedef T       value_type;
217   typedef T       key_type;
218   typedef Compare key_compare;
219   typedef Compare value_compare;
220
221   typedef typename ContainerT::pointer                pointer;
222   typedef typename ContainerT::reference              reference;
223   typedef typename ContainerT::const_reference        const_reference;
224   /*
225    * XXX: Our normal iterator ought to also be a constant iterator
226    * (cf. Defect Report 103 for std::set), but this is a bit more of a
227    * pain.
228    */
229   typedef typename ContainerT::iterator               iterator;
230   typedef typename ContainerT::const_iterator         const_iterator;
231   typedef typename ContainerT::difference_type        difference_type;
232   typedef typename ContainerT::size_type              size_type;
233   typedef typename ContainerT::reverse_iterator       reverse_iterator;
234   typedef typename ContainerT::const_reverse_iterator const_reverse_iterator;
235
236   explicit sorted_vector_set(const Compare& comp = Compare(),
237                              const Allocator& alloc = Allocator())
238     : m_(comp, alloc)
239   {}
240
241   template<class InputIterator>
242   explicit sorted_vector_set(
243       InputIterator first,
244       InputIterator last,
245       const Compare& comp = Compare(),
246       const Allocator& alloc = Allocator())
247     : m_(comp, alloc)
248   {
249     // This is linear if [first, last) is already sorted (and if we
250     // can figure out the distance between the two iterators).
251     insert(first, last);
252   }
253
254   /* implicit */ sorted_vector_set(
255       std::initializer_list<value_type> list,
256       const Compare& comp = Compare(),
257       const Allocator& alloc = Allocator())
258     : m_(comp, alloc)
259   {
260     insert(list.begin(), list.end());
261   }
262
263   // Construct a sorted_vector_set by stealing the storage of a prefilled
264   // container. The container need not be sorted already. This supports
265   // bulk construction of sorted_vector_set with zero allocations, not counting
266   // those performed by the caller. (The iterator range constructor performs at
267   // least one allocation).
268   //
269   // Note that `sorted_vector_set(const ContainerT& container)` is not provided,
270   // since the purpose of this constructor is to avoid an unnecessary copy.
271   explicit sorted_vector_set(
272       ContainerT&& container,
273       const Compare& comp = Compare())
274       : m_(comp, container.get_allocator()) {
275     std::sort(container.begin(), container.end(), value_comp());
276     m_.cont_.swap(container);
277   }
278
279   key_compare key_comp() const { return m_; }
280   value_compare value_comp() const { return m_; }
281
282   iterator begin()                      { return m_.cont_.begin();  }
283   iterator end()                        { return m_.cont_.end();    }
284   const_iterator cbegin() const         { return m_.cont_.cbegin(); }
285   const_iterator begin() const          { return m_.cont_.begin();  }
286   const_iterator cend() const           { return m_.cont_.cend();   }
287   const_iterator end() const            { return m_.cont_.end();    }
288   reverse_iterator rbegin()             { return m_.cont_.rbegin(); }
289   reverse_iterator rend()               { return m_.cont_.rend();   }
290   const_reverse_iterator rbegin() const { return m_.cont_.rbegin(); }
291   const_reverse_iterator rend() const   { return m_.cont_.rend();   }
292
293   void clear()                  { return m_.cont_.clear();    }
294   size_type size() const        { return m_.cont_.size();     }
295   size_type max_size() const    { return m_.cont_.max_size(); }
296   bool empty() const            { return m_.cont_.empty();    }
297   void reserve(size_type s)     { return m_.cont_.reserve(s); }
298   void shrink_to_fit()          { m_.cont_.shrink_to_fit();   }
299   size_type capacity() const    { return m_.cont_.capacity(); }
300
301   std::pair<iterator,bool> insert(const value_type& value) {
302     return insert(std::move(value_type(value)));
303   }
304
305   std::pair<iterator,bool> insert(value_type&& value) {
306     iterator it = lower_bound(value);
307     if (it == end() || value_comp()(value, *it)) {
308       it = get_growth_policy().increase_capacity(m_.cont_, it);
309       return std::make_pair(m_.cont_.insert(it, std::move(value)), true);
310     }
311     return std::make_pair(it, false);
312   }
313
314   iterator insert(iterator hint, const value_type& value) {
315     return insert(hint, std::move(value_type(value)));
316   }
317
318   iterator insert(iterator hint, value_type&& value) {
319     return detail::insert_with_hint(*this, m_.cont_, hint, std::move(value),
320       get_growth_policy());
321   }
322
323   template<class InputIterator>
324   void insert(InputIterator first, InputIterator last) {
325     detail::bulk_insert(*this, m_.cont_, first, last);
326   }
327
328   size_type erase(const key_type& key) {
329     iterator it = find(key);
330     if (it == end()) {
331       return 0;
332     }
333     m_.cont_.erase(it);
334     return 1;
335   }
336
337   void erase(iterator it) {
338     m_.cont_.erase(it);
339   }
340
341   void erase(iterator first, iterator last) {
342     m_.cont_.erase(first, last);
343   }
344
345   iterator find(const key_type& key) {
346     iterator it = lower_bound(key);
347     if (it == end() || !key_comp()(key, *it))
348       return it;
349     return end();
350   }
351
352   const_iterator find(const key_type& key) const {
353     const_iterator it = lower_bound(key);
354     if (it == end() || !key_comp()(key, *it))
355       return it;
356     return end();
357   }
358
359   size_type count(const key_type& key) const {
360     return find(key) == end() ? 0 : 1;
361   }
362
363   iterator lower_bound(const key_type& key) {
364     return std::lower_bound(begin(), end(), key, key_comp());
365   }
366
367   const_iterator lower_bound(const key_type& key) const {
368     return std::lower_bound(begin(), end(), key, key_comp());
369   }
370
371   iterator upper_bound(const key_type& key) {
372     return std::upper_bound(begin(), end(), key, key_comp());
373   }
374
375   const_iterator upper_bound(const key_type& key) const {
376     return std::upper_bound(begin(), end(), key, key_comp());
377   }
378
379   std::pair<iterator,iterator> equal_range(const key_type& key) {
380     return std::equal_range(begin(), end(), key, key_comp());
381   }
382
383   std::pair<const_iterator,const_iterator>
384   equal_range(const key_type& key) const {
385     return std::equal_range(begin(), end(), key, key_comp());
386   }
387
388   // Nothrow as long as swap() on the Compare type is nothrow.
389   void swap(sorted_vector_set& o) {
390     using std::swap;  // Allow ADL for swap(); fall back to std::swap().
391     Compare& a = m_;
392     Compare& b = o.m_;
393     swap(a, b);
394     m_.cont_.swap(o.m_.cont_);
395   }
396
397   bool operator==(const sorted_vector_set& other) const {
398     return other.m_.cont_ == m_.cont_;
399   }
400
401   bool operator<(const sorted_vector_set& other) const {
402     return m_.cont_ < other.m_.cont_;
403   }
404
405 private:
406   /*
407    * This structure derives from the comparison object in order to
408    * make use of the empty base class optimization if our comparison
409    * functor is an empty class (usual case).
410    *
411    * Wrapping up this member like this is better than deriving from
412    * the Compare object ourselves (there are some perverse edge cases
413    * involving virtual functions).
414    *
415    * More info:  http://www.cantrip.org/emptyopt.html
416    */
417   struct EBO : Compare {
418     explicit EBO(const Compare& c, const Allocator& alloc)
419       : Compare(c)
420       , cont_(alloc)
421     {}
422     ContainerT cont_;
423   } m_;
424 };
425
426 // Swap function that can be found using ADL.
427 template<class T, class C, class A, class G>
428 inline void swap(sorted_vector_set<T,C,A,G>& a,
429                  sorted_vector_set<T,C,A,G>& b) {
430   return a.swap(b);
431 }
432
433 //////////////////////////////////////////////////////////////////////
434
435 /**
436  * A sorted_vector_map is similar to a sorted_vector_set but stores
437  * <key,value> pairs instead of single elements.
438  *
439  * @param class Key           Key type
440  * @param class Value         Value type
441  * @param class Compare       Function that can compare key types and impose
442  *                            a strict weak ordering over them.
443  * @param class Allocator     allocation policy
444  * @param class GrowthPolicy  policy object to control growth
445  *
446  * @author Aditya Agarwal <aditya@fb.com>
447  * @author Akhil Wable    <akhil@fb.com>
448  * @author Jordan DeLong  <delong.j@fb.com>
449  */
450 template<class Key,
451          class Value,
452          class Compare        = std::less<Key>,
453          class Allocator      = std::allocator<std::pair<Key,Value> >,
454          class GrowthPolicy   = void>
455 class sorted_vector_map
456   : boost::totally_ordered1<
457       sorted_vector_map<Key,Value,Compare,Allocator,GrowthPolicy>
458     , detail::growth_policy_wrapper<GrowthPolicy> >
459 {
460   typedef std::vector<std::pair<Key,Value>,Allocator> ContainerT;
461
462   detail::growth_policy_wrapper<GrowthPolicy>&
463   get_growth_policy() { return *this; }
464
465 public:
466   typedef Key                                       key_type;
467   typedef Value                                     mapped_type;
468   typedef std::pair<key_type,mapped_type>           value_type;
469   typedef Compare                                   key_compare;
470
471   struct value_compare : private Compare {
472     bool operator()(const value_type& a, const value_type& b) const {
473       return Compare::operator()(a.first, b.first);
474     }
475
476   protected:
477     friend class sorted_vector_map;
478     explicit value_compare(const Compare& c) : Compare(c) {}
479   };
480
481   typedef typename ContainerT::pointer                pointer;
482   typedef typename ContainerT::reference              reference;
483   typedef typename ContainerT::const_reference        const_reference;
484   typedef typename ContainerT::iterator               iterator;
485   typedef typename ContainerT::const_iterator         const_iterator;
486   typedef typename ContainerT::difference_type        difference_type;
487   typedef typename ContainerT::size_type              size_type;
488   typedef typename ContainerT::reverse_iterator       reverse_iterator;
489   typedef typename ContainerT::const_reverse_iterator const_reverse_iterator;
490
491   explicit sorted_vector_map(const Compare& comp = Compare(),
492                              const Allocator& alloc = Allocator())
493     : m_(value_compare(comp), alloc)
494   {}
495
496   template<class InputIterator>
497   explicit sorted_vector_map(
498       InputIterator first,
499       InputIterator last,
500       const Compare& comp = Compare(),
501       const Allocator& alloc = Allocator())
502     : m_(value_compare(comp), alloc)
503   {
504     insert(first, last);
505   }
506
507   explicit sorted_vector_map(
508       std::initializer_list<value_type> list,
509       const Compare& comp = Compare(),
510       const Allocator& alloc = Allocator())
511     : m_(value_compare(comp), alloc)
512   {
513     insert(list.begin(), list.end());
514   }
515
516   // Construct a sorted_vector_map by stealing the storage of a prefilled
517   // container. The container need not be sorted already. This supports
518   // bulk construction of sorted_vector_map with zero allocations, not counting
519   // those performed by the caller. (The iterator range constructor performs at
520   // least one allocation).
521   //
522   // Note that `sorted_vector_map(const ContainerT& container)` is not provided,
523   // since the purpose of this constructor is to avoid an unnecessary copy.
524   explicit sorted_vector_map(
525       ContainerT&& container,
526       const Compare& comp = Compare())
527       : m_(value_compare(comp), container.get_allocator()) {
528     std::sort(container.begin(), container.end(), value_comp());
529     m_.cont_.swap(container);
530   }
531
532   key_compare key_comp() const { return m_; }
533   value_compare value_comp() const { return m_; }
534
535   iterator begin()                      { return m_.cont_.begin();  }
536   iterator end()                        { return m_.cont_.end();    }
537   const_iterator cbegin() const         { return m_.cont_.cbegin(); }
538   const_iterator begin() const          { return m_.cont_.begin();  }
539   const_iterator cend() const           { return m_.cont_.cend();   }
540   const_iterator end() const            { return m_.cont_.end();    }
541   reverse_iterator rbegin()             { return m_.cont_.rbegin(); }
542   reverse_iterator rend()               { return m_.cont_.rend();   }
543   const_reverse_iterator rbegin() const { return m_.cont_.rbegin(); }
544   const_reverse_iterator rend() const   { return m_.cont_.rend();   }
545
546   void clear()                  { return m_.cont_.clear();    }
547   size_type size() const        { return m_.cont_.size();     }
548   size_type max_size() const    { return m_.cont_.max_size(); }
549   bool empty() const            { return m_.cont_.empty();    }
550   void reserve(size_type s)     { return m_.cont_.reserve(s); }
551   void shrink_to_fit()          { m_.cont_.shrink_to_fit();   }
552   size_type capacity() const    { return m_.cont_.capacity(); }
553
554   std::pair<iterator,bool> insert(const value_type& value) {
555     return insert(std::move(value_type(value)));
556   }
557
558   std::pair<iterator,bool> insert(value_type&& value) {
559     iterator it = lower_bound(value.first);
560     if (it == end() || value_comp()(value, *it)) {
561       it = get_growth_policy().increase_capacity(m_.cont_, it);
562       return std::make_pair(m_.cont_.insert(it, std::move(value)), true);
563     }
564     return std::make_pair(it, false);
565   }
566
567   iterator insert(iterator hint, const value_type& value) {
568     return insert(hint, std::move(value_type(value)));
569   }
570
571   iterator insert(iterator hint, value_type&& value) {
572     return detail::insert_with_hint(*this, m_.cont_, hint, std::move(value),
573       get_growth_policy());
574   }
575
576   template<class InputIterator>
577   void insert(InputIterator first, InputIterator last) {
578     detail::bulk_insert(*this, m_.cont_, first, last);
579   }
580
581   size_type erase(const key_type& key) {
582     iterator it = find(key);
583     if (it == end()) {
584       return 0;
585     }
586     m_.cont_.erase(it);
587     return 1;
588   }
589
590   void erase(iterator it) {
591     m_.cont_.erase(it);
592   }
593
594   void erase(iterator first, iterator last) {
595     m_.cont_.erase(first, last);
596   }
597
598   iterator find(const key_type& key) {
599     iterator it = lower_bound(key);
600     if (it == end() || !key_comp()(key, it->first))
601       return it;
602     return end();
603   }
604
605   const_iterator find(const key_type& key) const {
606     const_iterator it = lower_bound(key);
607     if (it == end() || !key_comp()(key, it->first))
608       return it;
609     return end();
610   }
611
612   mapped_type& at(const key_type& key) {
613     iterator it = find(key);
614     if (it != end()) {
615       return it->second;
616     }
617     std::__throw_out_of_range("sorted_vector_map::at");
618   }
619
620   const mapped_type& at(const key_type& key) const {
621     const_iterator it = find(key);
622     if (it != end()) {
623       return it->second;
624     }
625     std::__throw_out_of_range("sorted_vector_map::at");
626   }
627
628   size_type count(const key_type& key) const {
629     return find(key) == end() ? 0 : 1;
630   }
631
632   iterator lower_bound(const key_type& key) {
633     auto c = key_comp();
634     auto f = [&](const value_type& a, const key_type& b) {
635       return c(a.first, b);
636     };
637     return std::lower_bound(begin(), end(), key, f);
638   }
639
640   const_iterator lower_bound(const key_type& key) const {
641     auto c = key_comp();
642     auto f = [&](const value_type& a, const key_type& b) {
643       return c(a.first, b);
644     };
645     return std::lower_bound(begin(), end(), key, f);
646   }
647
648   iterator upper_bound(const key_type& key) {
649     auto c = key_comp();
650     auto f = [&](const key_type& a, const value_type& b) {
651       return c(a, b.first);
652     };
653     return std::upper_bound(begin(), end(), key, f);
654   }
655
656   const_iterator upper_bound(const key_type& key) const {
657     auto c = key_comp();
658     auto f = [&](const key_type& a, const value_type& b) {
659       return c(a, b.first);
660     };
661     return std::upper_bound(begin(), end(), key, f);
662   }
663
664   std::pair<iterator,iterator> equal_range(const key_type& key) {
665     // Note: std::equal_range can't be passed a functor that takes
666     // argument types different from the iterator value_type, so we
667     // have to do this.
668     iterator low = lower_bound(key);
669     auto c = key_comp();
670     auto f = [&](const key_type& a, const value_type& b) {
671       return c(a, b.first);
672     };
673     iterator high = std::upper_bound(low, end(), key, f);
674     return std::make_pair(low, high);
675   }
676
677   std::pair<const_iterator,const_iterator>
678   equal_range(const key_type& key) const {
679     return const_cast<sorted_vector_map*>(this)->equal_range(key);
680   }
681
682   // Nothrow as long as swap() on the Compare type is nothrow.
683   void swap(sorted_vector_map& o) {
684     using std::swap; // Allow ADL for swap(); fall back to std::swap().
685     Compare& a = m_;
686     Compare& b = o.m_;
687     swap(a, b);
688     m_.cont_.swap(o.m_.cont_);
689   }
690
691   mapped_type& operator[](const key_type& key) {
692     iterator it = lower_bound(key);
693     if (it == end() || key_comp()(key, it->first)) {
694       return insert(it, value_type(key, mapped_type()))->second;
695     }
696     return it->second;
697   }
698
699   bool operator==(const sorted_vector_map& other) const {
700     return m_.cont_ == other.m_.cont_;
701   }
702
703   bool operator<(const sorted_vector_map& other) const {
704     return m_.cont_ < other.m_.cont_;
705   }
706
707 private:
708   // This is to get the empty base optimization; see the comment in
709   // sorted_vector_set.
710   struct EBO : value_compare {
711     explicit EBO(const value_compare& c, const Allocator& alloc)
712       : value_compare(c)
713       , cont_(alloc)
714     {}
715     ContainerT cont_;
716   } m_;
717 };
718
719 // Swap function that can be found using ADL.
720 template<class K, class V, class C, class A, class G>
721 inline void swap(sorted_vector_map<K,V,C,A,G>& a,
722                  sorted_vector_map<K,V,C,A,G>& b) {
723   return a.swap(b);
724 }
725
726 //////////////////////////////////////////////////////////////////////
727
728 }