| Home | Libraries | People | FAQ | More

## Class template set

boost::container::set

## Synopsis

    // In header: <boost/container/set.hpp>

    template<typename Key, typename Compare = std::less<Key>,
             typename Allocator = std::allocator<Key> >
    class set {
    public:
      // types
      typedef Key                                                                key_type;
      typedef Key                                                                value_type;
      typedef Compare                                                            key_compare;
      typedef Compare                                                            value_compare;
      typedef ::boost::container::allocator_traits< Allocator >::pointer         pointer;
      typedef ::boost::container::allocator_traits< Allocator >::const_pointer   const_pointer;
      typedef ::boost::container::allocator_traits< Allocator >::reference       reference;
      typedef ::boost::container::allocator_traits< Allocator >::const_reference const_reference;
      typedef ::boost::container::allocator_traits< Allocator >::size_type       size_type;
      typedef ::boost::container::allocator_traits< Allocator >::difference_type difference_type;
      typedef Allocator                                                          allocator_type;

      // construct/copy/destruct
      set();
      explicit set(const Compare &, const allocator_type & = allocator_type());
      template<typename InputIterator>
        set(InputIterator, InputIterator, const Compare & = Compare(),
            const allocator_type & = allocator_type());
      template<typename InputIterator>
        set(ordered_unique_range_t, InputIterator, InputIterator,
            const Compare & = Compare(),
            const allocator_type & = allocator_type());
      set(const set &);
      set(BOOST_RV_REF(set));
      set(const set &, const allocator_type &);
      set(BOOST_RV_REF(set), const allocator_type &);
      set& operator=(BOOST_COPY_ASSIGN_REF(set));
      set& operator=(BOOST_RV_REF(set));

      // public member functions
      typedef BOOST_CONTAINER_IMPDEF(tree_t::stored_allocator_type);
      typedef BOOST_CONTAINER_IMPDEF(tree_t::iterator);
      typedef BOOST_CONTAINER_IMPDEF(tree_t::const_iterator) const;
      typedef BOOST_CONTAINER_IMPDEF(tree_t::reverse_iterator);
      typedef BOOST_CONTAINER_IMPDEF(tree_t::const_reverse_iterator) const;
      allocator_type get_allocator() const;
      const stored_allocator_type & get_stored_allocator() const;
      stored_allocator_type & get_stored_allocator();
      iterator begin();
      const_iterator begin() const;
      iterator end();
      const_iterator end() const;
      reverse_iterator rbegin();
      const_reverse_iterator rbegin() const;
      reverse_iterator rend();
      const_reverse_iterator rend() const;
      const_iterator cbegin() const;
      const_iterator cend() const;
      const_reverse_iterator crbegin() const;
      const_reverse_iterator crend() const;
      bool empty() const;
      size_type size() const;
      size_type max_size() const;
      template<class... Args> std::pair< iterator, bool > emplace(Args &&...);
      template<class... Args> iterator emplace_hint(const_iterator, Args &&...);
      std::pair< iterator, bool > insert(const value_type &);
      std::pair< iterator, bool > insert(value_type &&);
       BOOST_MOVE_CONVERSION_AWARE_CATCH(insert, value_type, insert_return_pair,
                                         this->);
      iterator insert(const_iterator, value_type &&);
       BOOST_MOVE_CONVERSION_AWARE_CATCH_1ARG(insert, value_type, iterator,
                                              this->, const_iterator);
      iterator equal_range(const key_type &);
      std::pair< const_iterator, const_iterator >
      equal_range(const key_type &) const;

      // public data members
      const value_type & x;
    };

## Description

A set is a kind of associative container that supports unique keys (contains at most one of each key value) and provides for fast retrieval of the keys themselves. Class set supports bidirectional iterators.

A set satisfies all of the requirements of a container and of a reversible container , and of an associative container. A set also provides most operations described in for unique keys.

### `set` public construct/copy/destruct

1.     set();

   Effects: Default constructs an empty set.

   Complexity: Constant.

2.     explicit set(const Compare & comp,
                    const allocator_type & a = allocator_type());

   Effects: Constructs an empty set using the specified comparison object and allocator.

   Complexity: Constant.

3.     template<typename InputIterator>
         set(InputIterator first, InputIterator last,
             const Compare & comp = Compare(),
             const allocator_type & a = allocator_type());

   Effects: Constructs an empty set using the specified comparison object and allocator, and inserts elements from the range [first ,last ).

   Complexity: Linear in N if the range [first ,last ) is already sorted using comp and otherwise N logN, where N is last - first.

4.     template<typename InputIterator>
         set(ordered_unique_range_t, InputIterator first, InputIterator last,
             const Compare & comp = Compare(),
             const allocator_type & a = allocator_type());

   Effects: Constructs an empty set using the specified comparison object and allocator, and inserts elements from the ordered unique range [first ,last). This function is more efficient than the normal range creation for ordered ranges.

   Requires: [first ,last) must be ordered according to the predicate and must be unique values.

   Complexity: Linear in N.

5.     set(const set & x);

   Effects: Copy constructs a set.

   Complexity: Linear in x.size().

6.     set(BOOST_RV_REF(set) x);

   Effects: Move constructs a set. Constructs *this using x's resources.

   Complexity: Constant.

   Postcondition: x is emptied.

7.     set(const set & x, const allocator_type & a);

   Effects: Copy constructs a set using the specified allocator.

   Complexity: Linear in x.size().

8.     set(BOOST_RV_REF(set) x, const allocator_type & a);

   Effects: Move constructs a set using the specified allocator. Constructs *this using x's resources.

   Complexity: Constant if a == x.get_allocator(), linear otherwise.

9.     set& operator=(BOOST_COPY_ASSIGN_REF(set) x);

   Effects: Makes *this a copy of x.

   Complexity: Linear in x.size().

10.     set& operator=(BOOST_RV_REF(set) x);

    Effects: this->swap(x.get()).

    Complexity: Constant.

### `set` public member functions

1.     typedef BOOST_CONTAINER_IMPDEF(tree_t::stored_allocator_type);

2.     typedef BOOST_CONTAINER_IMPDEF(tree_t::iterator);

3.     typedef BOOST_CONTAINER_IMPDEF(tree_t::const_iterator) const;

4.     typedef BOOST_CONTAINER_IMPDEF(tree_t::reverse_iterator);

5.     typedef BOOST_CONTAINER_IMPDEF(tree_t::const_reverse_iterator) const;

6.     allocator_type get_allocator() const;

   Effects: Returns a copy of the Allocator that was passed to the object's constructor.

   Complexity: Constant.

7.     const stored_allocator_type & get_stored_allocator() const;

   Effects: Returns a reference to the internal allocator.

   Throws: Nothing

   Complexity: Constant.

   Note: Non-standard extension.

8.     stored_allocator_type & get_stored_allocator();

   Effects: Returns a reference to the internal allocator.

   Throws: Nothing

   Complexity: Constant.

   Note: Non-standard extension.

9.     iterator begin();

   Effects: Returns an iterator to the first element contained in the container.

   Throws: Nothing.

   Complexity: Constant

10.     const_iterator begin() const;

    Effects: Returns a const_iterator to the first element contained in the container.

    Throws: Nothing.

    Complexity: Constant.

11.     iterator end();

    Effects: Returns an iterator to the end of the container.

    Throws: Nothing.

    Complexity: Constant.

12.     const_iterator end() const;

    Effects: Returns a const_iterator to the end of the container.

    Throws: Nothing.

    Complexity: Constant.

13.     reverse_iterator rbegin();

    Effects: Returns a reverse_iterator pointing to the beginning of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

14.     const_reverse_iterator rbegin() const;

    Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

15.     reverse_iterator rend();

    Effects: Returns a reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

16.     const_reverse_iterator rend() const;

    Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

17.     const_iterator cbegin() const;

    Effects: Returns a const_iterator to the first element contained in the container.

    Throws: Nothing.

    Complexity: Constant.

18.     const_iterator cend() const;

    Effects: Returns a const_iterator to the end of the container.

    Throws: Nothing.

    Complexity: Constant.

19.     const_reverse_iterator crbegin() const;

    Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

20.     const_reverse_iterator crend() const;

    Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.

    Throws: Nothing.

    Complexity: Constant.

21.     bool empty() const;

    Effects: Returns true if the container contains no elements.

    Throws: Nothing.

    Complexity: Constant.

22.     size_type size() const;

    Effects: Returns the number of the elements contained in the container.

    Throws: Nothing.

    Complexity: Constant.

23.     size_type max_size() const;

    Effects: Returns the largest possible size of the container.

    Throws: Nothing.

    Complexity: Constant.

24.     template<class... Args> std::pair< iterator, bool > emplace(Args &&... args);

    Effects: Inserts an object x of type Key constructed with std::forward<Args>(args)... if and only if there is no element in the container with equivalent value. and returns the iterator pointing to the newly inserted element.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Throws: If memory allocation throws or Key's in-place constructor throws.

    Complexity: Logarithmic.

25.     template<class... Args>
          iterator emplace_hint(const_iterator hint, Args &&... args);

    Effects: Inserts an object of type Key constructed with std::forward<Args>(args)... if and only if there is no element in the container with equivalent value. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic.

26.     std::pair< iterator, bool > insert(const value_type & x);

    Effects: Inserts x if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic.

27.     std::pair< iterator, bool > insert(value_type && x);

    Effects: Move constructs a new value from x if and only if there is no element in the container with key equivalent to the key of x.

    Returns: The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of x.

    Complexity: Logarithmic.

28.      BOOST_MOVE_CONVERSION_AWARE_CATCH(insert, value_type, insert_return_pair,
                                           this-> priv_insert);

    Effects: Inserts a copy of x in the container if and only if there is no element in the container with key equivalent to the key of x. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic in general, but amortized constant if t is inserted right before p.

29.     iterator insert(const_iterator position, value_type && x);

    Effects: Inserts an element move constructed from x in the container. p is a hint pointing to where the insert should start to search.

    Returns: An iterator pointing to the element with key equivalent to the key of x.

    Complexity: Logarithmic.

30.      BOOST_MOVE_CONVERSION_AWARE_CATCH_1ARG(insert, value_type, iterator,
                                                this-> priv_insert, const_iterator);

    Requires: first, last are not iterators into *this.

    Effects: inserts each element from the range [first,last) if and only if there is no element with key equivalent to the key of that element.

    Complexity: At most N log(size()+N) (N is the distance from first to last)

31.     iterator equal_range(const key_type & x);

32.     std::pair< const_iterator, const_iterator >
        equal_range(const key_type & x) const;

    Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).

    Complexity: Logarithmic