libstdc++-v3/include/bits/stl_set.h

   1 // Set implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   4 // Free Software Foundation, Inc.
   5 //
   6 // This file is part of the GNU ISO C++ Library.  This library is free
   7 // software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the
   9 // Free Software Foundation; either version 3, or (at your option)
  10 // any later version.
  11
  12 // This library is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16
  17 // Under Section 7 of GPL version 3, you are granted additional
  18 // permissions described in the GCC Runtime Library Exception, version
  19 // 3.1, as published by the Free Software Foundation.
  20
  21 // You should have received a copy of the GNU General Public License and
  22 // a copy of the GCC Runtime Library Exception along with this program;
  23 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 // <http://www.gnu.org/licenses/>.
  25
  26 /*
  27  *
  28  * Copyright (c) 1994
  29  * Hewlett-Packard Company
  30  *
  31  * Permission to use, copy, modify, distribute and sell this software
  32  * and its documentation for any purpose is hereby granted without fee,
  33  * provided that the above copyright notice appear in all copies and
  34  * that both that copyright notice and this permission notice appear
  35  * in supporting documentation.  Hewlett-Packard Company makes no
  36  * representations about the suitability of this software for any
  37  * purpose.  It is provided "as is" without express or implied warranty.
  38  *
  39  *
  40  * Copyright (c) 1996,1997
  41  * Silicon Graphics Computer Systems, Inc.
  42  *
  43  * Permission to use, copy, modify, distribute and sell this software
  44  * and its documentation for any purpose is hereby granted without fee,
  45  * provided that the above copyright notice appear in all copies and
  46  * that both that copyright notice and this permission notice appear
  47  * in supporting documentation.  Silicon Graphics makes no
  48  * representations about the suitability of this software for any
  49  * purpose.  It is provided "as is" without express or implied warranty.
  50  */
  51
  52 /** @file stl_set.h
  53  *  This is an internal header file, included by other library headers.
  54  *  You should not attempt to use it directly.
  55  */
  56
  57 #ifndef _STL_SET_H
  58 #define _STL_SET_H 1
  59
  60 #include <bits/concept_check.h>
  61 #include <initializer_list>
  62
  63 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)
  64
  65   /**
  66    *  @brief A standard container made up of unique keys, which can be
  67    *  retrieved in logarithmic time.
  68    *
  69    *  @ingroup associative_containers
  70    *
  71    *  Meets the requirements of a <a href="tables.html#65">container</a>, a
  72    *  <a href="tables.html#66">reversible container</a>, and an
  73    *  <a href="tables.html#69">associative container</a> (using unique keys).
  74    *
  75    *  Sets support bidirectional iterators.
  76    *
  77    *  @param  Key  Type of key objects.
  78    *  @param  Compare  Comparison function object type, defaults to less<Key>.
  79    *  @param  Alloc  Allocator type, defaults to allocator<Key>.
  80    *
  81    *  The private tree data is declared exactly the same way for set and
  82    *  multiset; the distinction is made entirely in how the tree functions are
  83    *  called (*_unique versus *_equal, same as the standard).
  84   */
  85   template<typename _Key, typename _Compare = std::less<_Key>,
  86            typename _Alloc = std::allocator<_Key> >
  87     class set
  88     {
  89       // concept requirements
  90       typedef typename _Alloc::value_type                   _Alloc_value_type;
  91       __glibcxx_class_requires(_Key, _SGIAssignableConcept)
  92       __glibcxx_class_requires4(_Compare, bool, _Key, _Key,
  93                                 _BinaryFunctionConcept)
  94       __glibcxx_class_requires2(_Key, _Alloc_value_type, _SameTypeConcept)
  95
  96     public:
  97       // typedefs:
  98       //@{
  99       /// Public typedefs.
 100       typedef _Key     key_type;
 101       typedef _Key     value_type;
 102       typedef _Compare key_compare;
 103       typedef _Compare value_compare;
 104       typedef _Alloc   allocator_type;
 105       //@}
 106
 107     private:
 108       typedef typename _Alloc::template rebind<_Key>::other _Key_alloc_type;
 109
 110       typedef _Rb_tree<key_type, value_type, _Identity<value_type>,
 111                        key_compare, _Key_alloc_type> _Rep_type;
 112       _Rep_type _M_t;  // Red-black tree representing set.
 113
 114     public:
 115       //@{
 116       ///  Iterator-related typedefs.
 117       typedef typename _Key_alloc_type::pointer             pointer;
 118       typedef typename _Key_alloc_type::const_pointer       const_pointer;
 119       typedef typename _Key_alloc_type::reference           reference;
 120       typedef typename _Key_alloc_type::const_reference     const_reference;
 121       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 122       // DR 103. set::iterator is required to be modifiable,
 123       // but this allows modification of keys.
 124       typedef typename _Rep_type::const_iterator            iterator;
 125       typedef typename _Rep_type::const_iterator            const_iterator;
 126       typedef typename _Rep_type::const_reverse_iterator    reverse_iterator;
 127       typedef typename _Rep_type::const_reverse_iterator    const_reverse_iterator;
 128       typedef typename _Rep_type::size_type                 size_type;
 129       typedef typename _Rep_type::difference_type           difference_type;
 130       //@}
 131
 132       // allocation/deallocation
 133       /**
 134        *  @brief  Default constructor creates no elements.
 135        */
 136       set()
 137       : _M_t() { }
 138
 139       /**
 140        *  @brief  Creates a %set with no elements.
 141        *  @param  comp  Comparator to use.
 142        *  @param  a  An allocator object.
 143        */
 144       explicit
 145       set(const _Compare& __comp,
 146           const allocator_type& __a = allocator_type())
 147       : _M_t(__comp, __a) { }
 148
 149       /**
 150        *  @brief  Builds a %set from a range.
 151        *  @param  first  An input iterator.
 152        *  @param  last  An input iterator.
 153        *
 154        *  Create a %set consisting of copies of the elements from [first,last).
 155        *  This is linear in N if the range is already sorted, and NlogN
 156        *  otherwise (where N is distance(first,last)).
 157        */
 158       template<typename _InputIterator>
 159         set(_InputIterator __first, _InputIterator __last)
 160         : _M_t()
 161         { _M_t._M_insert_unique(__first, __last); }
 162
 163       /**
 164        *  @brief  Builds a %set from a range.
 165        *  @param  first  An input iterator.
 166        *  @param  last  An input iterator.
 167        *  @param  comp  A comparison functor.
 168        *  @param  a  An allocator object.
 169        *
 170        *  Create a %set consisting of copies of the elements from [first,last).
 171        *  This is linear in N if the range is already sorted, and NlogN
 172        *  otherwise (where N is distance(first,last)).
 173        */
 174       template<typename _InputIterator>
 175         set(_InputIterator __first, _InputIterator __last,
 176             const _Compare& __comp,
 177             const allocator_type& __a = allocator_type())
 178         : _M_t(__comp, __a)
 179         { _M_t._M_insert_unique(__first, __last); }
 180
 181       /**
 182        *  @brief  %Set copy constructor.
 183        *  @param  x  A %set of identical element and allocator types.
 184        *
 185        *  The newly-created %set uses a copy of the allocation object used
 186        *  by @a x.
 187        */
 188       set(const set& __x)
 189       : _M_t(__x._M_t) { }
 190
 191 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 192      /**
 193        *  @brief %Set move constructor
 194        *  @param x  A %set of identical element and allocator types.
 195        *
 196        *  The newly-created %set contains the exact contents of @a x.
 197        *  The contents of @a x are a valid, but unspecified %set.
 198        */
 199       set(set&& __x)
 200       : _M_t(std::forward<_Rep_type>(__x._M_t)) { }
 201
 202       /**
 203        *  @brief  Builds a %set from an initializer_list.
 204        *  @param  l  An initializer_list.
 205        *  @param  comp  A comparison functor.
 206        *  @param  a  An allocator object.
 207        *
 208        *  Create a %set consisting of copies of the elements in the list.
 209        *  This is linear in N if the list is already sorted, and NlogN
 210        *  otherwise (where N is @a l.size()).
 211        */
 212       set(initializer_list<value_type> __l,
 213           const _Compare& __comp = _Compare(),
 214           const allocator_type& __a = allocator_type())
 215       : _M_t(__comp, __a)
 216       { _M_t._M_insert_unique(__l.begin(), __l.end()); }
 217 #endif
 218
 219       /**
 220        *  @brief  %Set assignment operator.
 221        *  @param  x  A %set of identical element and allocator types.
 222        *
 223        *  All the elements of @a x are copied, but unlike the copy constructor,
 224        *  the allocator object is not copied.
 225        */
 226       set&
 227       operator=(const set& __x)
 228       {
 229         _M_t = __x._M_t;
 230         return *this;
 231       }
 232
 233 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 234       /**
 235        *  @brief %Set move assignment operator.
 236        *  @param x  A %set of identical element and allocator types.
 237        *
 238        *  The contents of @a x are moved into this %set (without copying).
 239        *  @a x is a valid, but unspecified %set.
 240        */
 241       set&
 242       operator=(set&& __x)
 243       {
 244         if (this != &__x)
 245           {
 246             // NB: DR 675.
 247             this->clear();
 248             this->swap(__x);
 249           }
 250         return *this;
 251       }
 252
 253       /**
 254        *  @brief  %Set list assignment operator.
 255        *  @param  l  An initializer_list.
 256        *
 257        *  This function fills a %set with copies of the elements in the
 258        *  initializer list @a l.
 259        *
 260        *  Note that the assignment completely changes the %set and
 261        *  that the resulting %set's size is the same as the number
 262        *  of elements assigned.  Old data may be lost.
 263        */
 264       set&
 265       operator=(initializer_list<value_type> __l)
 266       {
 267         this->clear();
 268         this->insert(__l.begin(), __l.end());
 269         return *this;
 270       }
 271 #endif
 272
 273       // accessors:
 274
 275       ///  Returns the comparison object with which the %set was constructed.
 276       key_compare
 277       key_comp() const
 278       { return _M_t.key_comp(); }
 279       ///  Returns the comparison object with which the %set was constructed.
 280       value_compare
 281       value_comp() const
 282       { return _M_t.key_comp(); }
 283       ///  Returns the allocator object with which the %set was constructed.
 284       allocator_type
 285       get_allocator() const
 286       { return _M_t.get_allocator(); }
 287
 288       /**
 289        *  Returns a read-only (constant) iterator that points to the first
 290        *  element in the %set.  Iteration is done in ascending order according
 291        *  to the keys.
 292        */
 293       iterator
 294       begin() const
 295       { return _M_t.begin(); }
 296
 297       /**
 298        *  Returns a read-only (constant) iterator that points one past the last
 299        *  element in the %set.  Iteration is done in ascending order according
 300        *  to the keys.
 301        */
 302       iterator
 303       end() const
 304       { return _M_t.end(); }
 305
 306       /**
 307        *  Returns a read-only (constant) iterator that points to the last
 308        *  element in the %set.  Iteration is done in descending order according
 309        *  to the keys.
 310        */
 311       reverse_iterator
 312       rbegin() const
 313       { return _M_t.rbegin(); }
 314
 315       /**
 316        *  Returns a read-only (constant) reverse iterator that points to the
 317        *  last pair in the %set.  Iteration is done in descending order
 318        *  according to the keys.
 319        */
 320       reverse_iterator
 321       rend() const
 322       { return _M_t.rend(); }
 323
 324 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 325       /**
 326        *  Returns a read-only (constant) iterator that points to the first
 327        *  element in the %set.  Iteration is done in ascending order according
 328        *  to the keys.
 329        */
 330       iterator
 331       cbegin() const
 332       { return _M_t.begin(); }
 333
 334       /**
 335        *  Returns a read-only (constant) iterator that points one past the last
 336        *  element in the %set.  Iteration is done in ascending order according
 337        *  to the keys.
 338        */
 339       iterator
 340       cend() const
 341       { return _M_t.end(); }
 342
 343       /**
 344        *  Returns a read-only (constant) iterator that points to the last
 345        *  element in the %set.  Iteration is done in descending order according
 346        *  to the keys.
 347        */
 348       reverse_iterator
 349       crbegin() const
 350       { return _M_t.rbegin(); }
 351
 352       /**
 353        *  Returns a read-only (constant) reverse iterator that points to the
 354        *  last pair in the %set.  Iteration is done in descending order
 355        *  according to the keys.
 356        */
 357       reverse_iterator
 358       crend() const
 359       { return _M_t.rend(); }
 360 #endif
 361
 362       ///  Returns true if the %set is empty.
 363       bool
 364       empty() const
 365       { return _M_t.empty(); }
 366
 367       ///  Returns the size of the %set.
 368       size_type
 369       size() const
 370       { return _M_t.size(); }
 371
 372       ///  Returns the maximum size of the %set.
 373       size_type
 374       max_size() const
 375       { return _M_t.max_size(); }
 376
 377       /**
 378        *  @brief  Swaps data with another %set.
 379        *  @param  x  A %set of the same element and allocator types.
 380        *
 381        *  This exchanges the elements between two sets in constant time.
 382        *  (It is only swapping a pointer, an integer, and an instance of
 383        *  the @c Compare type (which itself is often stateless and empty), so it
 384        *  should be quite fast.)
 385        *  Note that the global std::swap() function is specialized such that
 386        *  std::swap(s1,s2) will feed to this function.
 387        */
 388       void
 389       swap(set& __x)
 390       { _M_t.swap(__x._M_t); }
 391
 392       // insert/erase
 393       /**
 394        *  @brief Attempts to insert an element into the %set.
 395        *  @param  x  Element to be inserted.
 396        *  @return  A pair, of which the first element is an iterator that points
 397        *           to the possibly inserted element, and the second is a bool
 398        *           that is true if the element was actually inserted.
 399        *
 400        *  This function attempts to insert an element into the %set.  A %set
 401        *  relies on unique keys and thus an element is only inserted if it is
 402        *  not already present in the %set.
 403        *
 404        *  Insertion requires logarithmic time.
 405        */
 406       std::pair<iterator, bool>
 407       insert(const value_type& __x)
 408       {
 409         std::pair<typename _Rep_type::iterator, bool> __p =
 410           _M_t._M_insert_unique(__x);
 411         return std::pair<iterator, bool>(__p.first, __p.second);
 412       }
 413
 414       /**
 415        *  @brief Attempts to insert an element into the %set.
 416        *  @param  position  An iterator that serves as a hint as to where the
 417        *                    element should be inserted.
 418        *  @param  x  Element to be inserted.
 419        *  @return  An iterator that points to the element with key of @a x (may
 420        *           or may not be the element passed in).
 421        *
 422        *  This function is not concerned about whether the insertion took place,
 423        *  and thus does not return a boolean like the single-argument insert()
 424        *  does.  Note that the first parameter is only a hint and can
 425        *  potentially improve the performance of the insertion process.  A bad
 426        *  hint would cause no gains in efficiency.
 427        *
 428        *  For more on "hinting", see:
 429        *  http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
 430        *
 431        *  Insertion requires logarithmic time (if the hint is not taken).
 432        */
 433       iterator
 434       insert(iterator __position, const value_type& __x)
 435       { return _M_t._M_insert_unique_(__position, __x); }
 436
 437       /**
 438        *  @brief A template function that attempts to insert a range
 439        *  of elements.
 440        *  @param  first  Iterator pointing to the start of the range to be
 441        *                 inserted.
 442        *  @param  last  Iterator pointing to the end of the range.
 443        *
 444        *  Complexity similar to that of the range constructor.
 445        */
 446       template<typename _InputIterator>
 447         void
 448         insert(_InputIterator __first, _InputIterator __last)
 449         { _M_t._M_insert_unique(__first, __last); }
 450
 451 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 452       /**
 453        *  @brief Attempts to insert a list of elements into the %set.
 454        *  @param  list  A std::initializer_list<value_type> of elements
 455        *                to be inserted.
 456        *
 457        *  Complexity similar to that of the range constructor.
 458        */
 459       void
 460       insert(initializer_list<value_type> __l)
 461       { this->insert(__l.begin(), __l.end()); }
 462 #endif
 463
 464 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 465       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 466       // DR 130. Associative erase should return an iterator.
 467       /**
 468        *  @brief Erases an element from a %set.
 469        *  @param  position  An iterator pointing to the element to be erased.
 470        *  @return An iterator pointing to the element immediately following
 471        *          @a position prior to the element being erased. If no such
 472        *          element exists, end() is returned.
 473        *
 474        *  This function erases an element, pointed to by the given iterator,
 475        *  from a %set.  Note that this function only erases the element, and
 476        *  that if the element is itself a pointer, the pointed-to memory is not
 477        *  touched in any way.  Managing the pointer is the user's responsibility.
 478        */
 479       iterator
 480       erase(iterator __position)
 481       { return _M_t.erase(__position); }
 482 #else
 483       /**
 484        *  @brief Erases an element from a %set.
 485        *  @param  position  An iterator pointing to the element to be erased.
 486        *
 487        *  This function erases an element, pointed to by the given iterator,
 488        *  from a %set.  Note that this function only erases the element, and
 489        *  that if the element is itself a pointer, the pointed-to memory is not
 490        *  touched in any way.  Managing the pointer is the user's responsibility.
 491        */
 492       void
 493       erase(iterator __position)
 494       { _M_t.erase(__position); }
 495 #endif
 496
 497       /**
 498        *  @brief Erases elements according to the provided key.
 499        *  @param  x  Key of element to be erased.
 500        *  @return  The number of elements erased.
 501        *
 502        *  This function erases all the elements located by the given key from
 503        *  a %set.
 504        *  Note that this function only erases the element, and that if
 505        *  the element is itself a pointer, the pointed-to memory is not touched
 506        *  in any way.  Managing the pointer is the user's responsibility.
 507        */
 508       size_type
 509       erase(const key_type& __x)
 510       { return _M_t.erase(__x); }
 511
 512 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 513       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 514       // DR 130. Associative erase should return an iterator.
 515       /**
 516        *  @brief Erases a [first,last) range of elements from a %set.
 517        *  @param  first  Iterator pointing to the start of the range to be
 518        *                 erased.
 519        *  @param  last  Iterator pointing to the end of the range to be erased.
 520        *  @return The iterator @a last.
 521        *
 522        *  This function erases a sequence of elements from a %set.
 523        *  Note that this function only erases the element, and that if
 524        *  the element is itself a pointer, the pointed-to memory is not touched
 525        *  in any way.  Managing the pointer is the user's responsibility.
 526        */
 527       iterator
 528       erase(iterator __first, iterator __last)
 529       { return _M_t.erase(__first, __last); }
 530 #else
 531       /**
 532        *  @brief Erases a [first,last) range of elements from a %set.
 533        *  @param  first  Iterator pointing to the start of the range to be
 534        *                 erased.
 535        *  @param  last  Iterator pointing to the end of the range to be erased.
 536        *
 537        *  This function erases a sequence of elements from a %set.
 538        *  Note that this function only erases the element, and that if
 539        *  the element is itself a pointer, the pointed-to memory is not touched
 540        *  in any way.  Managing the pointer is the user's responsibility.
 541        */
 542       void
 543       erase(iterator __first, iterator __last)
 544       { _M_t.erase(__first, __last); }
 545 #endif
 546
 547       /**
 548        *  Erases all elements in a %set.  Note that this function only erases
 549        *  the elements, and that if the elements themselves are pointers, the
 550        *  pointed-to memory is not touched in any way.  Managing the pointer is
 551        *  the user's responsibility.
 552        */
 553       void
 554       clear()
 555       { _M_t.clear(); }
 556
 557       // set operations:
 558
 559       /**
 560        *  @brief  Finds the number of elements.
 561        *  @param  x  Element to located.
 562        *  @return  Number of elements with specified key.
 563        *
 564        *  This function only makes sense for multisets; for set the result will
 565        *  either be 0 (not present) or 1 (present).
 566        */
 567       size_type
 568       count(const key_type& __x) const
 569       { return _M_t.find(__x) == _M_t.end() ? 0 : 1; }
 570
 571       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 572       // 214.  set::find() missing const overload
 573       //@{
 574       /**
 575        *  @brief Tries to locate an element in a %set.
 576        *  @param  x  Element to be located.
 577        *  @return  Iterator pointing to sought-after element, or end() if not
 578        *           found.
 579        *
 580        *  This function takes a key and tries to locate the element with which
 581        *  the key matches.  If successful the function returns an iterator
 582        *  pointing to the sought after element.  If unsuccessful it returns the
 583        *  past-the-end ( @c end() ) iterator.
 584        */
 585       iterator
 586       find(const key_type& __x)
 587       { return _M_t.find(__x); }
 588
 589       const_iterator
 590       find(const key_type& __x) const
 591       { return _M_t.find(__x); }
 592       //@}
 593
 594       //@{
 595       /**
 596        *  @brief Finds the beginning of a subsequence matching given key.
 597        *  @param  x  Key to be located.
 598        *  @return  Iterator pointing to first element equal to or greater
 599        *           than key, or end().
 600        *
 601        *  This function returns the first element of a subsequence of elements
 602        *  that matches the given key.  If unsuccessful it returns an iterator
 603        *  pointing to the first element that has a greater value than given key
 604        *  or end() if no such element exists.
 605        */
 606       iterator
 607       lower_bound(const key_type& __x)
 608       { return _M_t.lower_bound(__x); }
 609
 610       const_iterator
 611       lower_bound(const key_type& __x) const
 612       { return _M_t.lower_bound(__x); }
 613       //@}
 614
 615       //@{
 616       /**
 617        *  @brief Finds the end of a subsequence matching given key.
 618        *  @param  x  Key to be located.
 619        *  @return Iterator pointing to the first element
 620        *          greater than key, or end().
 621        */
 622       iterator
 623       upper_bound(const key_type& __x)
 624       { return _M_t.upper_bound(__x); }
 625
 626       const_iterator
 627       upper_bound(const key_type& __x) const
 628       { return _M_t.upper_bound(__x); }
 629       //@}
 630
 631       //@{
 632       /**
 633        *  @brief Finds a subsequence matching given key.
 634        *  @param  x  Key to be located.
 635        *  @return  Pair of iterators that possibly points to the subsequence
 636        *           matching given key.
 637        *
 638        *  This function is equivalent to
 639        *  @code
 640        *    std::make_pair(c.lower_bound(val),
 641        *                   c.upper_bound(val))
 642        *  @endcode
 643        *  (but is faster than making the calls separately).
 644        *
 645        *  This function probably only makes sense for multisets.
 646        */
 647       std::pair<iterator, iterator>
 648       equal_range(const key_type& __x)
 649       { return _M_t.equal_range(__x); }
 650
 651       std::pair<const_iterator, const_iterator>
 652       equal_range(const key_type& __x) const
 653       { return _M_t.equal_range(__x); }
 654       //@}
 655
 656       template<typename _K1, typename _C1, typename _A1>
 657         friend bool
 658         operator==(const set<_K1, _C1, _A1>&, const set<_K1, _C1, _A1>&);
 659
 660       template<typename _K1, typename _C1, typename _A1>
 661         friend bool
 662         operator<(const set<_K1, _C1, _A1>&, const set<_K1, _C1, _A1>&);
 663     };
 664
 665
 666   /**
 667    *  @brief  Set equality comparison.
 668    *  @param  x  A %set.
 669    *  @param  y  A %set of the same type as @a x.
 670    *  @return  True iff the size and elements of the sets are equal.
 671    *
 672    *  This is an equivalence relation.  It is linear in the size of the sets.
 673    *  Sets are considered equivalent if their sizes are equal, and if
 674    *  corresponding elements compare equal.
 675   */
 676   template<typename _Key, typename _Compare, typename _Alloc>
 677     inline bool
 678     operator==(const set<_Key, _Compare, _Alloc>& __x,
 679                const set<_Key, _Compare, _Alloc>& __y)
 680     { return __x._M_t == __y._M_t; }
 681
 682   /**
 683    *  @brief  Set ordering relation.
 684    *  @param  x  A %set.
 685    *  @param  y  A %set of the same type as @a x.
 686    *  @return  True iff @a x is lexicographically less than @a y.
 687    *
 688    *  This is a total ordering relation.  It is linear in the size of the
 689    *  maps.  The elements must be comparable with @c <.
 690    *
 691    *  See std::lexicographical_compare() for how the determination is made.
 692   */
 693   template<typename _Key, typename _Compare, typename _Alloc>
 694     inline bool
 695     operator<(const set<_Key, _Compare, _Alloc>& __x,
 696               const set<_Key, _Compare, _Alloc>& __y)
 697     { return __x._M_t < __y._M_t; }
 698
 699   ///  Returns !(x == y).
 700   template<typename _Key, typename _Compare, typename _Alloc>
 701     inline bool
 702     operator!=(const set<_Key, _Compare, _Alloc>& __x,
 703                const set<_Key, _Compare, _Alloc>& __y)
 704     { return !(__x == __y); }
 705
 706   ///  Returns y < x.
 707   template<typename _Key, typename _Compare, typename _Alloc>
 708     inline bool
 709     operator>(const set<_Key, _Compare, _Alloc>& __x,
 710               const set<_Key, _Compare, _Alloc>& __y)
 711     { return __y < __x; }
 712
 713   ///  Returns !(y < x)
 714   template<typename _Key, typename _Compare, typename _Alloc>
 715     inline bool
 716     operator<=(const set<_Key, _Compare, _Alloc>& __x,
 717                const set<_Key, _Compare, _Alloc>& __y)
 718     { return !(__y < __x); }
 719
 720   ///  Returns !(x < y)
 721   template<typename _Key, typename _Compare, typename _Alloc>
 722     inline bool
 723     operator>=(const set<_Key, _Compare, _Alloc>& __x,
 724                const set<_Key, _Compare, _Alloc>& __y)
 725     { return !(__x < __y); }
 726
 727   /// See std::set::swap().
 728   template<typename _Key, typename _Compare, typename _Alloc>
 729     inline void
 730     swap(set<_Key, _Compare, _Alloc>& __x, set<_Key, _Compare, _Alloc>& __y)
 731     { __x.swap(__y); }
 732
 733 _GLIBCXX_END_NESTED_NAMESPACE
 734
 735 #endif /* _STL_SET_H */