---
name: "__gnu_debug::def_set"
section: "3"
platform: "linux"
package: "libstdc++6-doc"
version: "3.4.6-5"
release: "Debian 4.0 (Etch)"
platforms: ["linux"]
url: "https://new.carta.tech/__gnu_debug::def_set"
---

# \_\_gnu\_debug::def\_set(3)

## NAME

\_\_gnu\_debug\_def::set -

## SYNOPSIS

Inherits **std::set\< Key, Compare, Allocator \>**, and **\_\_gnu\_debug::Safe\_sequence\< Sequence \>\< \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \> \>**.

### Public Types

typedef Key **key\_type**\
 *Public typedefs.*  typedef Key **value\_type**\
 typedef Compare **key\_compare**\
 typedef Compare **value\_compare**\
 typedef Allocator **allocator\_type**\
 typedef Allocator::reference **reference**\
 typedef Allocator::const\_reference **const\_reference**\
 typedef **\_\_gnu\_debug::Safe\_iterator**\< typename **Base::iterator**, **set** \> **iterator**\
 typedef **\_\_gnu\_debug::Safe\_iterator**\< typename **Base::const\_iterator**, **set** \> **const\_iterator**\
 typedef **Base::size\_type** **size\_type**\
 typedef **Base::difference\_type** **difference\_type**\
 typedef Allocator::pointer **pointer**\
 *Iterator-related typedefs.*  typedef Allocator::const\_pointer **const\_pointer**\
 typedef **std::reverse\_iterator**\< **iterator** \> **reverse\_iterator**\
 typedef **std::reverse\_iterator**\< **const\_iterator** \> **const\_reverse\_iterator**\

### Public Member Functions

**set** (const Compare &comp=Compare(), const Allocator &a=Allocator())\
 template\<typename InputIterator\> **set** (InputIterator first, InputIterator last, const Compare &comp=Compare(), const Allocator &a=Allocator())\
 **set** (const **set**\< Key, Compare, Allocator \> &x)\
 **set** (const **Base** &x)\
 *Set copy constructor.*  **~set** ()\
 **set**\< Key, Compare, Allocator \> & **operator=** (const **set**\< Key, Compare, Allocator \> &x)\
 **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\
 **std::pair**\< **iterator**, bool \> **insert** (const **value\_type** &x)\
 *Attempts to insert an element into the set.*  **iterator** **insert** (**iterator** position, const **value\_type** &x)\
 template\<typename InputIterator\> void **insert** (InputIterator first, InputIterator last)\
 *A template function that attemps to insert a range of elements.*  void **erase** (**iterator** position)\
 **size\_type** **erase** (const **key\_type** &x)\
 *Erases elements according to the provided key.*  void **erase** (**iterator** first, **iterator** last)\
 void **swap** (**set**\< Key, Compare, Allocator \> &x)\
 void **clear** ()\
 **iterator** **find** (const **key\_type** &x)\
 *Tries to locate an element in a set.*  **const\_iterator** **find** (const **key\_type** &x) const\
 **iterator** **lower\_bound** (const **key\_type** &x)\
 *Finds the beginning of a subsequence matching given key.*  **const\_iterator** **lower\_bound** (const **key\_type** &x) const\
 **iterator** **upper\_bound** (const **key\_type** &x)\
 *Finds the end of a subsequence matching given key.*  **const\_iterator** **upper\_bound** (const **key\_type** &x) const\
 **std::pair**\< **iterator**, **iterator** \> **equal\_range** (const **key\_type** &x)\
 *Finds a subsequence matching given key.*  **std::pair**\< **const\_iterator**, **const\_iterator** \> **equal\_range** (const **key\_type** &x) const\
 **Base** & **M\_base** ()\
 const **Base** & **M\_base** () const\
 **key\_compare** **key\_comp** () const\
 *Returns the comparison object with which the set was constructed.*  **value\_compare** **value\_comp** () const\
 *Returns the comparison object with which the set was constructed.*  **allocator\_type** **get\_allocator** () const\
 *Returns the allocator object with which the set was constructed.*  bool **empty** () const\
 *Returns true if the set is empty.*  **size\_type** **size** () const\
 *Returns the size of the set.*  **size\_type** **max\_size** () const\
 *Returns the maximum size of the set.*  void **swap** (**set**\< Key, Compare, Allocator \> &x)\
 *Swaps data with another set.*  **iterator** **insert** (**iterator** position, const **value\_type** &x)\
 *Attempts to insert an element into the set.*  void **erase** (**iterator** position)\
 *Erases an element from a set.*  void **erase** (**iterator** first, **iterator** last)\
 *Erases a \[first,last) range of elements from a set.*  **size\_type** **count** (const **key\_type** &x) const\
 *Finds the number of elements.*  template\<typename Predicate\> void **M\_invalidate\_if** (Predicate pred)\
 template\<typename Iterator\> void **M\_transfer\_iter** (const Safe\_iterator\< Iterator, Sequence \> &x)\
 void **M\_invalidate\_all** () const\

### Public Attributes

Safe\_iterator\_base \* **M\_iterators**\
 *The list of mutable iterators that reference this container.*  Safe\_iterator\_base \* **M\_const\_iterators**\
 *The list of constant iterators that reference this container.*  unsigned int **M\_version**\
 *The container version number. This number may never be 0.*

### Protected Member Functions

void **M\_detach\_all** ()\
 void **M\_detach\_singular** ()\
 void **M\_revalidate\_singular** ()\
 void **M\_swap** (Safe\_sequence\_base &x)\

### Private Types

typedef **std::set**\< Key, Compare, Allocator \> **Base**\
 typedef **\_\_gnu\_debug::Safe\_sequence**\< **set** \> **Safe\_base**\

### Private Member Functions

void **M\_invalidate\_all** ()\

## Detailed Description

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> class \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>

Definition at line 42 of file debug/set.h.

## Member Typedef Documentation

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> typedef Key \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::key\_type

Public typedefs.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 51 of file debug/set.h.

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> typedef Allocator::pointer \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::pointer

Iterator-related typedefs.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 66 of file debug/set.h.

## Constructor & Destructor Documentation

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::set (const Base & x)` [inline]`

Set copy constructor.

**Parameters:**

*x* A set of identical element and allocator types.

The newly-created set uses a copy of the allocation object used by *x*.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 86 of file debug/set.h.

## Member Function Documentation

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> const\_iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::begin () const` [inline]`

Returns a read/write iterator that points to the first element in the set. Iteration is done in ascending order according to the keys.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 106 of file debug/set.h.

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> const\_iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::end () const` [inline]`

Returns a read/write iterator that points one past the last element in the set. Iteration is done in ascending order according to the keys.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 114 of file debug/set.h.

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> const\_reverse\_iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::rbegin () const` [inline]`

Returns a read/write reverse iterator that points to the last element in the set. Iteration is done in descending order according to the keys.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 122 of file debug/set.h.

References \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::end().

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> const\_reverse\_iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::rend () const` [inline]`

Returns a read-only (constant) reverse iterator that points to the last pair in the map. Iteration is done in descending order according to the keys.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 130 of file debug/set.h.

References \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::begin().

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> std::pair\<iterator, bool\> \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::insert (const value\_type & x)` [inline]`

Attempts to insert an element into the set.

**Parameters:**

*x* Element to be inserted.

**Returns:**

A pair, of which the first element is an iterator that points to the possibly inserted element, and the second is a bool that is true if the element was actually inserted.

This function attempts to insert an element into the set. A set relies on unique keys and thus an element is only inserted if it is not already present in the set.

Insertion requires logarithmic time.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 140 of file debug/set.h.

References std::pair\< T1, T2 \>::first, and std::pair\< T1, T2 \>::second.

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> template\<typename InputIterator\> void \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::insert (InputIterator first, InputIterator last)` [inline]`

A template function that attemps to insert a range of elements.

**Parameters:**

*first* Iterator pointing to the start of the range to be inserted. \
 *last* Iterator pointing to the end of the range.

Complexity similar to that of the range constructor.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 157 of file debug/set.h.

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> size\_type \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::erase (const key\_type & x)` [inline]`

Erases elements according to the provided key.

**Parameters:**

*x* Key of element to be erased.

**Returns:**

The number of elements erased.

This function erases all the elements located by the given key from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibilty.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 172 of file debug/set.h.

References \_\_gnu\_debug::Safe\_iterator\< Iterator, Sequence \>::base(), \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::end(), and \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::find().

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> void \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::clear ()` [inline]`

Erases all elements in a set. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibilty.

Reimplemented from **std::set\< Key, Compare, Allocator \>**.

Definition at line 204 of file debug/set.h.

References \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::begin(), \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::end(), and \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::erase().

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::find (const key\_type & x)` [inline]`

Tries to locate an element in a set.

**Parameters:**

*x* Element to be located.

**Returns:**

Iterator pointing to sought-after element, or **end()** if not found.

This function takes a key and tries to locate the element with which the key matches. If successful the function returns an iterator pointing to the sought after element. If unsuccessful it returns the past-the-end ( **end() ) iterator.**

**Reimplemented from std::set\< Key, Compare, Allocator \>.**

**Definition at line 213 of file debug/set.h.**

**References std::find().**

**Referenced by \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::erase().**

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::lower\_bound (const key\_type & x)` [inline]`

**Finds the beginning of a subsequence matching given key.**

**Parameters:**

*x* **Key to be located.**

**Returns:**

**Iterator pointing to first element equal to or greater than key, or end().**

**This function returns the first element of a subsequence of elements that matches the given key. If unsuccessful it returns an iterator pointing to the first element that has a greater value than given key or end() if no such element exists.**

**Reimplemented from std::set\< Key, Compare, Allocator \>.**

**Definition at line 225 of file debug/set.h.**

**References std::lower\_bound().**

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> iterator \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::upper\_bound (const key\_type & x)` [inline]`

**Finds the end of a subsequence matching given key.**

**Parameters:**

*x* **Key to be located.**

**Returns:**

**Iterator pointing to the first element greater than key, or end().**

**Reimplemented from std::set\< Key, Compare, Allocator \>.**

**Definition at line 235 of file debug/set.h.**

**References std::upper\_bound().**

### template\<typename Key, typename Compare = std::less\<Key\>, typename Allocator = std::allocator\<Key\>\> std::pair\<iterator,iterator\> \_\_gnu\_debug\_def::set\< Key, Compare, Allocator \>::equal\_range (const key\_type & x)` [inline]`

**Finds a subsequence matching given key.**

**Parameters:**

*x* **Key to be located.**

**Returns:**

**Pair of iterators that possibly points to the subsequence matching given key.**

**This function is equivalent to**

```
    std::make_pair(c.lower_bound(val),
                   c.upper_bound(val))
```

 **(but is faster than making the calls separately).**

**This function probably only makes sense for multisets.**

**Reimplemented from std::set\< Key, Compare, Allocator \>.**

**Definition at line 245 of file debug/set.h.**

**References std::equal\_range(), std::pair\< T1, T2 \>::first, std::make\_pair(), and std::pair\< T1, T2 \>::second.**

### key\_compare std::set\< Key , Compare , Allocator \>::key\_comp () const` [inline, inherited]`

**Returns the comparison object with which the set was constructed.**

**Definition at line 222 of file stl\_set.h.**

**References std::set\< Key, Compare, Alloc \>::key\_comp().**

### value\_compare std::set\< Key , Compare , Allocator \>::value\_comp () const` [inline, inherited]`

**Returns the comparison object with which the set was constructed.**

**Definition at line 226 of file stl\_set.h.**

### allocator\_type std::set\< Key , Compare , Allocator \>::get\_allocator () const` [inline, inherited]`

**Returns the allocator object with which the set was constructed.**

**Definition at line 230 of file stl\_set.h.**

### bool std::set\< Key , Compare , Allocator \>::empty () const` [inline, inherited]`

**Returns true if the set is empty.**

**Definition at line 269 of file stl\_set.h.**

### size\_type std::set\< Key , Compare , Allocator \>::size () const` [inline, inherited]`

**Returns the size of the set.**

**Definition at line 274 of file stl\_set.h.**

### size\_type std::set\< Key , Compare , Allocator \>::max\_size (void) const` [inline, inherited]`

**Returns the maximum size of the set.**

**Definition at line 279 of file stl\_set.h.**

### void std::set\< Key , Compare , Allocator \>::swap (set\< Key , Compare , Allocator \> & x)` [inline, inherited]`

**Swaps data with another set.**

**Parameters:**

*x* **A set of the same element and allocator types.**

**This exchanges the elements between two sets in constant time. (It is only swapping a pointer, an integer, and an instance of the** `Compare` **type (which itself is often stateless and empty), so it should be quite fast.) Note that the global std::swap() function is specialized such that std::swap(s1,s2) will feed to this function.**

**Definition at line 294 of file stl\_set.h.**

### iterator std::set\< Key , Compare , Allocator \>::insert (iterator position, const value\_type & x)` [inline, inherited]`

**Attempts to insert an element into the set.**

**Parameters:**

*position* **An iterator that serves as a hint as to where the element should be inserted.** \
 *x* **Element to be inserted.**

**Returns:**

**An iterator that points to the element with key of** *x* **(may or may not be the element passed in).**

**This function is not concerned about whether the insertion took place, and thus does not return a boolean like the single-argument insert() does. Note that the first parameter is only a hint and can potentially improve the performance of the insertion process. A bad hint would cause no gains in efficiency.**

**See http://gcc.gnu.org/onlinedocs/libstdc++/23\_containers/howto.html#4 for more on 'hinting'.**

**Insertion requires logarithmic time (if the hint is not taken).**

**Definition at line 338 of file stl\_set.h.**

### void std::set\< Key , Compare , Allocator \>::erase (iterator position)` [inline, inherited]`

**Erases an element from a set.**

**Parameters:**

*position* **An iterator pointing to the element to be erased.**

**This function erases an element, pointed to by the given iterator, from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibilty.**

**Definition at line 367 of file stl\_set.h.**

### void std::set\< Key , Compare , Allocator \>::erase (iterator first, iterator last)` [inline, inherited]`

**Erases a \[first,last) range of elements from a set.**

**Parameters:**

*first* **Iterator pointing to the start of the range to be erased.** \
 *last* **Iterator pointing to the end of the range to be erased.**

**This function erases a sequence of elements from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibilty.**

**Definition at line 399 of file stl\_set.h.**

### size\_type std::set\< Key , Compare , Allocator \>::count (const key\_type & x) const` [inline, inherited]`

**Finds the number of elements.**

**Parameters:**

*x* **Element to located.**

**Returns:**

**Number of elements with specified key.**

**This function only makes sense for multisets; for set the result will either be 0 (not present) or 1 (present).**

**Definition at line 426 of file stl\_set.h.**

### template\<typename Sequence\> template\<typename Predicate\> void \_\_gnu\_debug::Safe\_sequence\< Sequence \>::M\_invalidate\_if (Predicate pred)` [inherited]`

**Invalidates all iterators** `x` **that reference this sequence, are not singular, and for which** `pred(x)` **returns** `true`**. The user of this routine should be careful not to make copies of the iterators passed to** `pred`**, as the copies may interfere with the invalidation.**

**Definition at line 120 of file safe\_sequence.h.**

### template\<typename Sequence\> template\<typename Iterator\> void \_\_gnu\_debug::Safe\_sequence\< Sequence \>::M\_transfer\_iter (const Safe\_iterator\< Iterator, Sequence \> & x)` [inherited]`

**Transfers all iterators that reference this memory location to this sequence from whatever sequence they are attached to.**

**Definition at line 152 of file safe\_sequence.h.**

### void \_\_gnu\_debug::Safe\_sequence\_base::M\_detach\_all ()` [protected, inherited]`

**Detach all iterators, leaving them singular.**

**Definition at line 114 of file debug.cc.**

### void \_\_gnu\_debug::Safe\_sequence\_base::M\_detach\_singular ()` [protected, inherited]`

**Detach all singular iterators.**

**Postcondition:**

**for all iterators i attached to this sequence, i-\>M\_version == M\_version.**

**Definition at line 133 of file debug.cc.**

### void \_\_gnu\_debug::Safe\_sequence\_base::M\_revalidate\_singular ()` [protected, inherited]`

**Revalidates all attached singular iterators. This method may be used to validate iterators that were invalidated before (but for some reasion, such as an exception, need to become valid again).**

**Definition at line 154 of file debug.cc.**

### void \_\_gnu\_debug::Safe\_sequence\_base::M\_swap (Safe\_sequence\_base & x)` [protected, inherited]`

**Swap this sequence with the given sequence. This operation also swaps ownership of the iterators, so that when the operation is complete all iterators that originally referenced one container now reference the other container.**

**Definition at line 172 of file debug.cc.**

**References \_\_gnu\_debug::swap().**

### void \_\_gnu\_debug::Safe\_sequence\_base::M\_invalidate\_all () const` [inline, inherited]`

**Invalidates all iterators.**

**Definition at line 202 of file safe\_base.h.**

## Member Data Documentation

### Safe\_iterator\_base\* \_\_gnu\_debug::Safe\_sequence\_base::M\_iterators` [inherited]`

**The list of mutable iterators that reference this container.**

**Definition at line 153 of file safe\_base.h.**

### Safe\_iterator\_base\* \_\_gnu\_debug::Safe\_sequence\_base::M\_const\_iterators` [inherited]`

**The list of constant iterators that reference this container.**

**Definition at line 156 of file safe\_base.h.**

### unsigned int \_\_gnu\_debug::Safe\_sequence\_base::M\_version` [mutable, inherited]`

**The container version number. This number may never be 0.**

**Definition at line 159 of file safe\_base.h.**

## Author

**Generated automatically by Doxygen for libstdc++-v3 Source from the source code.**