![]() |
Home | Libraries | People | FAQ | More |
boost::container::set
// In header: <boost/container/set.hpp> template<typename Key, typename Compare = Key>, typename Allocator = new_allocator<Key>, typename Options = void> class set { public: // types typedef Key ; typedef Key ; typedef Compare ; typedef key_compare ; typedef ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef ::boost::container::allocator_traits< ; typedef implementation_defined ; typedef implementation_defined ; typedef implementation_defined ; typedef implementation_defined ; typedef implementation_defined ; typedef implementation_defined ; typedef implementation_defined ; // construct/copy/destruct () ; (const ); (const Compare &); (const Compare &, const ); template<typename InputIterator> (InputIterator, InputIterator); template<typename InputIterator> (InputIterator, InputIterator, const ); template<typename InputIterator> (InputIterator, InputIterator, const Compare &); template<typename InputIterator> (InputIterator, InputIterator, const Compare &, const ); template<typename InputIterator> (ordered_unique_range_t, InputIterator, InputIterator); template<typename InputIterator> (ordered_unique_range_t, InputIterator, InputIterator, const Compare &); template<typename InputIterator> (ordered_unique_range_t, InputIterator, InputIterator, const Compare &, const ); template<typename InputIterator> (ordered_unique_range_t, InputIterator, InputIterator, const ); (); (, const ); (, const Compare &); (, const Compare &, const ); (ordered_unique_range_t, ); (ordered_unique_range_t, , const Compare &); (ordered_unique_range_t, , const Compare &, const ); (const set &); (set &&) ; (const set &, const ); (set &&, const ); set & (const set &); set & (set &&) ; set & (); // public member functions () ; stored_allocator_type & (); const stored_allocator_type & () ; iterator (); () ; () ; iterator (); () ; () ; reverse_iterator (); const_reverse_iterator () ; const_reverse_iterator () ; reverse_iterator (); const_reverse_iterator () ; const_reverse_iterator () ; bool () ; size_type () ; size_type () ; template< Args> iterator, bool > (Args &&...); template< Args> iterator (, Args &&...); iterator, bool > (const ); iterator, bool > (); iterator (, const ); iterator (, ); template<typename InputIterator> void (InputIterator, InputIterator); void (); insert_return_type (); insert_return_type (, ); template<typename C2> void (set< Key, C2, Allocator, Options > &); template<typename C2> void (set< Key, C2, Allocator, Options > &&); template<typename C2> void (multiset< Key, C2, Allocator, Options > &); template<typename C2> void (multiset< Key, C2, Allocator, Options > &&); size_type (const ); iterator (); iterator (, ); (); (const ); void (set &) ; void (); key_compare () ; value_compare () ; iterator (const ); (const ) ; template<typename K> iterator (const K &); template<typename K> (const K &) ; size_type (const ) ; template<typename K> size_type (const K &) ; bool (const ) ; template<typename K> bool (const K &) ; iterator (const ); (const ) ; template<typename K> iterator (const K &); template<typename K> (const K &) ; iterator (const ); (const ) ; template<typename K> iterator (const K &); template<typename K> (const K &) ; iterator, iterator > (const ); (const ) ; template<typename K> iterator, iterator > (const K &); template<typename K> (const K &) ; void (); // friend functions bool (const set &, const set &); bool (const set &, const set &); bool (const set &, const set &); bool (const set &, const set &); bool (const set &, const set &); bool (const set &, const set &); void (set &, set &) ; };
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.
typename Key
is the type to be inserted in the set, which is also the key_type
typename Compare = Key>
is the comparison functor used to order keys
typename Allocator = new_allocator<Key>
is the allocator to be used to allocate memory for this container
typename Options = void
is an packed option type generated using using boost::container::tree_assoc_options
.
set
public
construct/copy/destruct() ;
Effects: Default constructs an empty set.
Complexity: Constant.
(const a);
Effects: Constructs an empty set using the specified allocator object.
Complexity: Constant.
(const Compare & comp);
Effects: Constructs an empty set using the specified comparison object.
Complexity: Constant.
(const Compare & comp, const a);
Effects: Constructs an empty set using the specified comparison object and allocator.
Complexity: Constant.
template<typename InputIterator> (InputIterator first, InputIterator last);
Effects: Constructs an empty set using and inserts elements from the range [first ,last ).
Complexity: Linear in N if the range [first ,last ) is already sorted using the predicate and otherwise N logN, where N is last - first.
template<typename InputIterator> (InputIterator first, InputIterator last, const a);
Effects: Constructs an empty set using the specified allocator, and inserts elements from the range [first ,last ).
Complexity: Linear in N if the range [first ,last ) is already sorted using the predicate and otherwise N logN, where N is last - first.
template<typename InputIterator> (InputIterator first, InputIterator last, const Compare & comp);
Effects: Constructs an empty set using the specified comparison object and inserts elements from the range [first ,last ).
Complexity: Linear in N if the range [first ,last ) is already sorted using the predicate and otherwise N logN, where N is last - first.
template<typename InputIterator> (InputIterator first, InputIterator last, const Compare & comp, const a);
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 the predicate and otherwise N logN, where N is last - first.
template<typename InputIterator> (ordered_unique_range_t, InputIterator first, InputIterator last);
Effects: Constructs an empty set 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.
Note: Non-standard extension.
template<typename InputIterator> (ordered_unique_range_t, InputIterator first, InputIterator last, const Compare & comp);
Effects: Constructs an empty set using the specified comparison object 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.
Note: Non-standard extension.
template<typename InputIterator> (ordered_unique_range_t, InputIterator first, InputIterator last, const Compare & comp, const a);
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.
Note: Non-standard extension.
template<typename InputIterator> (ordered_unique_range_t, InputIterator first, InputIterator last, const a);
Effects: Constructs an empty set using the specified 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.
Note: Non-standard extension.
( il);
Effects: Constructs an empty set and inserts elements from the range [il.begin(), il.end()).
Complexity: Linear in N if the range [il.begin(), il.end()) is already sorted using the predicate and otherwise N logN, where N is il.begin() - il.end().
( il, const a);
Effects: Constructs an empty set using the specified allocator, and inserts elements from the range [il.begin(), il.end()).
Complexity: Linear in N if the range [il.begin(), il.end()) is already sorted using the predicate and otherwise N logN, where N is il.begin() - il.end().
( il, const Compare & comp);
Effects: Constructs an empty set using the specified comparison object and inserts elements from the range [il.begin(), il.end()).
Complexity: Linear in N if the range [il.begin(), il.end()) is already sorted using the predicate and otherwise N logN, where N is il.begin() - il.end().
( il, const Compare & comp, const a);
Effects: Constructs an empty set using the specified comparison object and allocator, and inserts elements from the range [il.begin(), il.end()).
Complexity: Linear in N if the range [il.begin(), il.end()) is already sorted using the predicate and otherwise N logN, where N is il.begin() - il.end().
(ordered_unique_range_t, il);
Effects: Constructs an empty set and inserts elements from the ordered unique range [il.begin(), il.end()). This function is more efficient than the normal range creation for ordered ranges.
Requires: [il.begin(), il.end()) must be ordered according to the predicate and must be unique values.
Complexity: Linear in N.
Note: Non-standard extension.
(ordered_unique_range_t, il, const Compare & comp);
Effects: Constructs an empty set using the specified comparison object and inserts elements from the ordered unique range [il.begin(), il.end()). This function is more efficient than the normal range creation for ordered ranges.
Requires: [il.begin(), il.end()) must be ordered according to the predicate and must be unique values.
Complexity: Linear in N.
Note: Non-standard extension.
(ordered_unique_range_t, il, const Compare & comp, const a);
Effects: Constructs an empty set using the specified comparison object and allocator, and inserts elements from the ordered unique range [il.begin(), il.end()). This function is more efficient than the normal range creation for ordered ranges.
Requires: [il.begin(), il.end()) must be ordered according to the predicate and must be unique values.
Complexity: Linear in N.
Note: Non-standard extension.
(const set & x);
Effects: Copy constructs a set.
Complexity: Linear in x.size().
(set && x) ;
Effects: Move constructs a set. Constructs *this using x's resources.
Complexity: Constant.
Postcondition: x is emptied.
(const set & x, const a);
Effects: Copy constructs a set using the specified allocator.
Complexity: Linear in x.size().
(set && x, const 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.
set & (const set & x);
Effects: Makes *this a copy of x.
Complexity: Linear in x.size().
set & (set && x) ;
Effects: this->swap(x.get()).
Throws: If allocator_traits_type::propagate_on_container_move_assignment is false and (allocation throws or value_type's move constructor throws)
Complexity: Constant if allocator_traits_type:: propagate_on_container_move_assignment is true or this->get>allocator() == x.get_allocator(). Linear otherwise.
set & ( il);
Effects: Copy all elements from il to *this.
Complexity: Linear in il.size().
set
public member functions() ;
Effects: Returns a copy of the allocator that was passed to the object's constructor.
Complexity: Constant.
stored_allocator_type & ();
Effects: Returns a reference to the internal allocator.
Throws: Nothing
Complexity: Constant.
Note: Non-standard extension.
const stored_allocator_type & () ;
Effects: Returns a reference to the internal allocator.
Throws: Nothing
Complexity: Constant.
Note: Non-standard extension.
iterator ();
Effects: Returns an iterator to the first element contained in the container.
Throws: Nothing.
Complexity: Constant
() ;
Effects: Returns a const_iterator to the first element contained in the container.
Throws: Nothing.
Complexity: Constant.
() ;
Effects: Returns a const_iterator to the first element contained in the container.
Throws: Nothing.
Complexity: Constant.
iterator ();
Effects: Returns an iterator to the end of the container.
Throws: Nothing.
Complexity: Constant.
() ;
Effects: Returns a const_iterator to the end of the container.
Throws: Nothing.
Complexity: Constant.
() ;
Effects: Returns a const_iterator to the end of the container.
Throws: Nothing.
Complexity: Constant.
reverse_iterator ();
Effects: Returns a reverse_iterator pointing to the beginning of the reversed container.
Throws: Nothing.
Complexity: Constant.
const_reverse_iterator () ;
Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.
Throws: Nothing.
Complexity: Constant.
const_reverse_iterator () ;
Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed container.
Throws: Nothing.
Complexity: Constant.
reverse_iterator ();
Effects: Returns a reverse_iterator pointing to the end of the reversed container.
Throws: Nothing.
Complexity: Constant.
const_reverse_iterator () ;
Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.
Throws: Nothing.
Complexity: Constant.
const_reverse_iterator () ;
Effects: Returns a const_reverse_iterator pointing to the end of the reversed container.
Throws: Nothing.
Complexity: Constant.
bool () ;
Effects: Returns true if the container contains no elements.
Throws: Nothing.
Complexity: Constant.
size_type () ;
Effects: Returns the number of the elements contained in the container.
Throws: Nothing.
Complexity: Constant.
size_type () ;
Effects: Returns the largest possible size of the container.
Throws: Nothing.
Complexity: Constant.
template< Args> iterator, bool > (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.
template< Args> iterator ( p, 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.
iterator, bool > (const 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.
iterator, bool > ( 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.
iterator ( p, const x);
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.
iterator ( p, 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.
template<typename InputIterator> void (InputIterator first, InputIterator last);
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)
void ( il);
Effects: inserts each element from the range [il.begin(),il.end()) 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 il.begin() to il.end())
insert_return_type ( nh);
Requires: nh is empty or this->get_allocator() == nh.get_allocator().
Effects: If nh is empty, has no effect. Otherwise, inserts the element owned by nh if and only if there is no element in the container with a key equivalent to nh.key().
Returns: If nh is empty, insert_return_type.inserted is false, insert_return_type.position is end(), and insert_return_type.node is empty. Otherwise if the insertion took place, insert_return_type.inserted is true, insert_return_type.position points to the inserted element, and insert_return_type.node is empty; if the insertion failed, insert_return_type.inserted is false, insert_return_type.node has the previous value of nh, and insert_return_type.position points to an element with a key equivalent to nh.key().
Complexity: Logarithmic
insert_return_type ( hint, nh);
Effects: Same as insert(node_type && nh)
but the element is inserted as close as possible to the position just prior to "hint".
Complexity: logarithmic in general, but amortized constant if the element is inserted right before "hint".
template<typename C2> void (set< Key, C2, Allocator, Options > & source);
Requires: this->get_allocator() == source.get_allocator().
Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.
Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.
Throws: Nothing unless the comparison object throws.
Complexity: N log(size() + N) (N has the value source.size())
template<typename C2> void (set< Key, C2, Allocator, Options > && source);
Requires: this->get_allocator() == source.get_allocator().
Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.
Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.
Throws: Nothing unless the comparison object throws.
Complexity: N log(size() + N) (N has the value source.size())
template<typename C2> void (multiset< Key, C2, Allocator, Options > & source);
Requires: this->get_allocator() == source.get_allocator().
Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.
Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.
Throws: Nothing unless the comparison object throws.
Complexity: N log(size() + N) (N has the value source.size())
template<typename C2> void (multiset< Key, C2, Allocator, Options > && source);
Requires: this->get_allocator() == source.get_allocator().
Effects: Attempts to extract each element in source and insert it into a using the comparison object of *this. If there is an element in a with key equivalent to the key of an element from source, then that element is not extracted from source.
Postcondition: Pointers and references to the transferred elements of source refer to those same elements but as members of *this. Iterators referring to the transferred elements will continue to refer to their elements, but they now behave as iterators into *this, not into source.
Throws: Nothing unless the comparison object throws.
Complexity: N log(size() + N) (N has the value source.size())
size_type (const x);
Effects: If present, erases the element in the container with key equivalent to x.
Returns: Returns the number of erased elements (0/1).
Complexity: log(size()) + count(k)
iterator ( p);
Effects: Erases the element pointed to by p.
Returns: Returns an iterator pointing to the element immediately following q prior to the element being erased. If no such element exists, returns end().
Complexity: Amortized constant time
iterator ( first, last);
Effects: Erases all the elements in the range [first, last).
Returns: Returns last.
Complexity: log(size())+N where N is the distance from first to last.
( p);
Effects: Removes the element pointed to by "position".
Returns: A node_type owning the element, otherwise an empty node_type.
Complexity: Amortized constant.
(const x);
Effects: Removes the first element in the container with key equivalent to k.
Returns: A node_type owning the element if found, otherwise an empty node_type.
Complexity: log(size()).
void (set & x) ;
Effects: Swaps the contents of *this and x.
Throws: Nothing.
Complexity: Constant.
void ();
Effects: erase(begin(),end()).
Postcondition: size() == 0.
Complexity: linear in size().
key_compare () ;
Effects: Returns the comparison object out of which a was constructed.
Complexity: Constant.
value_compare () ;
Effects: Returns an object of value_compare constructed out of the comparison object.
Complexity: Constant.
iterator (const x);
Returns: An iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.
Complexity: Logarithmic.
(const x) ;
Returns: A const_iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.
Complexity: Logarithmic.
template<typename K> iterator (const K & x);
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: An iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.
Complexity: Logarithmic.
template<typename K> (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: A const_iterator pointing to an element with the key equivalent to x, or end() if such an element is not found.
Complexity: Logarithmic.
size_type (const x) ;
Returns: The number of elements with key equivalent to x.
Complexity: log(size())+count(k)
template<typename K> size_type (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: The number of elements with key equivalent to x.
Complexity: log(size())+count(k)
bool (const x) ;
Returns: Returns true if there is an element with key equivalent to key in the container, otherwise false.
Complexity: log(size()).
template<typename K> bool (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: Returns true if there is an element with key equivalent to key in the container, otherwise false.
Complexity: log(size()).
iterator (const x);
Returns: An iterator pointing to the first element with key not less than x, or end() if such an element is not found.
Complexity: Logarithmic
(const x) ;
Returns: A const iterator pointing to the first element with key not less than x, or end() if such an element is not found.
Complexity: Logarithmic
template<typename K> iterator (const K & x);
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: An iterator pointing to the first element with key not less than x, or end() if such an element is not found.
Complexity: Logarithmic
template<typename K> (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: A const iterator pointing to the first element with key not less than x, or end() if such an element is not found.
Complexity: Logarithmic
iterator (const x);
Returns: An iterator pointing to the first element with key greater than x, or end() if such an element is not found.
Complexity: Logarithmic
(const x) ;
Returns: A const iterator pointing to the first element with key greater than x, or end() if such an element is not found.
Complexity: Logarithmic
template<typename K> iterator (const K & x);
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: An iterator pointing to the first element with key greater than x, or end() if such an element is not found.
Complexity: Logarithmic
template<typename K> (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Returns: A const iterator pointing to the first element with key greater than x, or end() if such an element is not found.
Complexity: Logarithmic
iterator, iterator > (const x);
Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).
Complexity: Logarithmic
(const x) ;
Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).
Complexity: Logarithmic
template<typename K> iterator, iterator > (const K & x);
Requires: This overload is available only if key_compare::is_transparent exists.
Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).
Complexity: Logarithmic
template<typename K> (const K & x) ;
Requires: This overload is available only if key_compare::is_transparent exists.
Effects: Equivalent to std::make_pair(this->lower_bound(k), this->upper_bound(k)).
Complexity: Logarithmic
void ();
Effects: Rebalances the tree. It's a no-op for Red-Black and AVL trees.
Complexity: Linear
set
friend functionsbool (const set & x, const set & y);
Effects: Returns true if x and y are equal
Complexity: Linear to the number of elements in the container.
bool (const set & x, const set & y);
Effects: Returns true if x and y are unequal
Complexity: Linear to the number of elements in the container.
bool (const set & x, const set & y);
Effects: Returns true if x is less than y
Complexity: Linear to the number of elements in the container.
bool (const set & x, const set & y);
Effects: Returns true if x is greater than y
Complexity: Linear to the number of elements in the container.
bool (const set & x, const set & y);
Effects: Returns true if x is equal or less than y
Complexity: Linear to the number of elements in the container.
bool (const set & x, const set & y);
Effects: Returns true if x is equal or greater than y
Complexity: Linear to the number of elements in the container.
void (set & x, set & y) ;
Effects: x.swap(y)
Complexity: Constant.