#include <bslstl_multiset.h>

Public Types
typedef KEY	key_type

typedef KEY	value_type

typedef COMPARATOR	key_compare

typedef COMPARATOR	value_compare

typedef ALLOCATOR	allocator_type

typedef value_type &	reference

typedef const value_type &	const_reference

typedef AllocatorTraits::size_type	size_type

typedef AllocatorTraits::difference_type	difference_type

typedef AllocatorTraits::pointer	pointer

typedef AllocatorTraits::const_pointer	const_pointer

typedef BloombergLP::bslstl::TreeIterator< const value_type, Node, difference_type >	iterator

typedef BloombergLP::bslstl::TreeIterator< const value_type, Node, difference_type >	const_iterator

typedef bsl::reverse_iterator< iterator >	reverse_iterator

typedef bsl::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
	multiset ()

	multiset (const COMPARATOR &comparator, const ALLOCATOR &basicAllocator=ALLOCATOR())

	multiset (const ALLOCATOR &basicAllocator)

	multiset (const multiset &original)

	multiset (BloombergLP::bslmf::MovableRef< multiset > original)

	multiset (const multiset &original, const typename type_identity< ALLOCATOR >::type &basicAllocator)

	multiset (BloombergLP::bslmf::MovableRef< multiset > original, const typename type_identity< ALLOCATOR >::type &basicAllocator)

template<class INPUT_ITERATOR >
	multiset (INPUT_ITERATOR first, INPUT_ITERATOR last, const COMPARATOR &comparator=COMPARATOR(), const ALLOCATOR &basicAllocator=ALLOCATOR())

template<class INPUT_ITERATOR >
	multiset (INPUT_ITERATOR first, INPUT_ITERATOR last, const ALLOCATOR &basicAllocator)

	~multiset ()
	Destroy this object.

multiset &	operator= (const multiset &rhs)

multiset &operator=(BloombergLP::bslmf::MovableRef< multiset > rhs) BSLS_KEYWORD_NOEXCEPT_SPECIFICATION(AllocatorTraits iterator	begin () BSLS_KEYWORD_NOEXCEPT

iterator	end () BSLS_KEYWORD_NOEXCEPT

reverse_iterator	rbegin () BSLS_KEYWORD_NOEXCEPT

reverse_iterator	rend () BSLS_KEYWORD_NOEXCEPT

iterator	insert (const value_type &value)

iterator	insert (BloombergLP::bslmf::MovableRef< value_type > value)

iterator	insert (const_iterator hint, const value_type &value)

iterator	insert (const_iterator hint, BloombergLP::bslmf::MovableRef< value_type > value)

template<class INPUT_ITERATOR >
void	insert (INPUT_ITERATOR first, INPUT_ITERATOR last)

template<class... Args>
iterator	emplace (Args &&... args)

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

iterator	erase (const_iterator position)

size_type	erase (const key_type &key)

iterator	erase (const_iterator first, const_iterator last)

iterator	find (const key_type &key)

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type	find (const LOOKUP_KEY &key)

iterator	lower_bound (const key_type &key)

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type	lower_bound (const LOOKUP_KEY &key)

iterator	upper_bound (const key_type &key)

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type	upper_bound (const LOOKUP_KEY &key)

pair< iterator, iterator >	equal_range (const key_type &key)

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, pair< iterator, iterator > >::type	equal_range (const LOOKUP_KEY &key)

allocator_type	get_allocator () const BSLS_KEYWORD_NOEXCEPT

const_iterator	begin () const BSLS_KEYWORD_NOEXCEPT

const_iterator	end () const BSLS_KEYWORD_NOEXCEPT

const_reverse_iterator	rbegin () const BSLS_KEYWORD_NOEXCEPT

const_reverse_iterator	rend () const BSLS_KEYWORD_NOEXCEPT

const_iterator	cbegin () const BSLS_KEYWORD_NOEXCEPT

const_iterator	cend () const BSLS_KEYWORD_NOEXCEPT

const_reverse_iterator	crbegin () const BSLS_KEYWORD_NOEXCEPT

const_reverse_iterator	crend () const BSLS_KEYWORD_NOEXCEPT

bool	contains (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, bool >::type	contains (const LOOKUP_KEY &key) const

bool	empty () const BSLS_KEYWORD_NOEXCEPT

size_type	size () const BSLS_KEYWORD_NOEXCEPT
	Return the number of elements in this multiset.

size_type	max_size () const BSLS_KEYWORD_NOEXCEPT

key_compare	key_comp () const

value_compare	value_comp () const

const_iterator	find (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type	find (const LOOKUP_KEY &key) const

size_type	count (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, size_type >::type	count (const LOOKUP_KEY &key) const

const_iterator	lower_bound (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type	lower_bound (const LOOKUP_KEY &key) const

const_iterator	upper_bound (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type	upper_bound (const LOOKUP_KEY &key) const

pair< const_iterator, const_iterator >	equal_range (const key_type &key) const

template<class LOOKUP_KEY >
bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, pair< const_iterator, const_iterator > >::type	equal_range (const LOOKUP_KEY &key) const

Public Attributes
void swap(multiset &other) BSLS_KEYWORD_NOEXCEPT_SPECIFICATION(AllocatorTraits void	clear () BSLS_KEYWORD_NOEXCEPT

Detailed Description

template<class KEY, class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>
class bsl::multiset< KEY, COMPARATOR, ALLOCATOR >

This class template implements a value-semantic container type holding an ordered sequence of possibly duplicate keys (of the template parameter type, KEY).

This class:

supports a complete set of value-semantic operations
- except for BDEX serialization
is exception-neutral (agnostic except for the at method)
is alias-safe
is const thread-safe For terminology see bsldoc_glossary .

See bslstl_multiset

Member Typedef Documentation

◆ allocator_type

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef ALLOCATOR bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::allocator_type

◆ const_iterator

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef BloombergLP::bslstl::TreeIterator<const value_type, Node, difference_type> bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::const_iterator

◆ const_pointer

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef AllocatorTraits::const_pointer bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::const_pointer

◆ const_reference

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef const value_type& bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::const_reference

◆ const_reverse_iterator

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef bsl::reverse_iterator<const_iterator> bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::const_reverse_iterator

◆ difference_type

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef AllocatorTraits::difference_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::difference_type

◆ iterator

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef BloombergLP::bslstl::TreeIterator<const value_type, Node, difference_type> bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::iterator

◆ key_compare

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef COMPARATOR bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::key_compare

◆ key_type

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef KEY bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::key_type

◆ pointer

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef AllocatorTraits::pointer bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::pointer

◆ reference

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef value_type& bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::reference

◆ reverse_iterator

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef bsl::reverse_iterator<iterator> bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::reverse_iterator

◆ size_type

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef AllocatorTraits::size_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::size_type

◆ value_compare

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef COMPARATOR bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::value_compare

◆ value_type

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

typedef KEY bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::value_type

Constructor & Destructor Documentation

◆ multiset() [1/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset ( )

inline

◆ multiset() [2/9]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset	(	const COMPARATOR &	comparator,
		const ALLOCATOR &	basicAllocator = `ALLOCATOR()`
	)

inlineexplicit

Create an empty multiset. Optionally specify a comparator used to order keys contained in this object. If comparator is not supplied, a default-constructed object of the (template parameter) type COMPARATOR is used. Optionally specify the basicAllocator used to supply memory. If basicAllocator is not supplied, a default-constructed object of the (template parameter) type ALLOCATOR is used. If the type ALLOCATOR is bsl::allocator (the default), then basicAllocator, if supplied, shall be convertible to bslma::Allocator *. If the type ALLOCATOR is bsl::allocator and basicAllocator is not supplied, the currently installed default allocator is used.

◆ multiset() [3/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset ( const ALLOCATOR & basicAllocator )

inlineexplicit

Create an empty multiset that uses the specified basicAllocator to supply memory. Use a default-constructed object of the (template parameter) type COMPARATOR to order the keys contained in this multiset. Note that a bslma::Allocator * can be supplied for basicAllocator if the (template parameter) ALLOCATOR is bsl::allocator (the default).

◆ multiset() [4/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset ( const multiset< KEY, COMPARATOR, ALLOCATOR > & original )

inline

Create a multiset having the same value as the specified original object. Use a copy of original.key_comp() to order the keys contained in this multiset. Use the allocator returned by 'bsl::allocator_traits<ALLOCATOR>:: select_on_container_copy_construction(original.get_allocator())' to allocate memory. This method requires that the (template parameter) type KEY be copy-insertable into this multiset (see {Requirements on KEY}).

◆ multiset() [5/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset ( BloombergLP::bslmf::MovableRef< multiset< KEY, COMPARATOR, ALLOCATOR > > original )

inline

Create a multiset having the same value as that of the specified original object by moving (in constant time) the contents of original to the new multiset. Use a copy of original.key_comp() to order the keys contained in this multiset. The allocator associated with original is propagated for use in the newly-created multiset. original is left in a valid but unspecified state.

◆ multiset() [6/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset	(	const multiset< KEY, COMPARATOR, ALLOCATOR > &	original,
		const typename type_identity< ALLOCATOR >::type &	basicAllocator
	)

inline

Create a multiset having the same value as the specified original object that uses the specified basicAllocator to supply memory. Use a copy of original.key_comp() to order the keys contained in this multiset. This method requires that the (template parameter) type KEY be copy-insertable into this multiset (see {Requirements on KEY}). Note that a bslma::Allocator * can be supplied for basicAllocator if the (template parameter) type ALLOCATOR is bsl::allocator (the default).

◆ multiset() [7/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset	(	BloombergLP::bslmf::MovableRef< multiset< KEY, COMPARATOR, ALLOCATOR > >	original,
		const typename type_identity< ALLOCATOR >::type &	basicAllocator
	)

inline

Create a multiset having the same value as the specified original object that uses the specified basicAllocator to supply memory. The contents of original are moved (in constant time) to the new multiset if basicAllocator == original.get_allocator(), and are move-inserted (in linear time) using basicAllocator otherwise. original is left in a valid but unspecified state. Use a copy of original.key_comp() to order the keys contained in this multiset. This method requires that the (template parameter) type KEY be move-insertable into this multiset (see {Requirements on KEY}). Note that a bslma::Allocator * can be supplied for basicAllocator if the (template parameter) type ALLOCATOR is bsl::allocator (the default).

◆ multiset() [8/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

template<class INPUT_ITERATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset	(	INPUT_ITERATOR	first,
		INPUT_ITERATOR	last,
		const COMPARATOR &	comparator = `COMPARATOR()`,
		const ALLOCATOR &	basicAllocator = `ALLOCATOR()`
	)

inline

Create a multiset, and insert each value_type object in the sequence starting at the specified first element, and ending immediately before the specified last element. Optionally specify a comparator used to order keys contained in this object. If comparator is not supplied, a default-constructed object of the (template parameter) type COMPARATOR is used. Optionally specify a basicAllocator used to supply memory. If basicAllocator is not supplied, a default-constructed object of the (template parameter) type ALLOCATOR is used. If the type ALLOCATOR is bsl::allocator and basicAllocator is not supplied, the currently installed default allocator is used. If the sequence first to last is ordered according to comparator, then this operation has O[N] complexity, where N is the number of elements between first and last, otherwise this operation has O[N * log(N)] complexity. The (template parameter) type INPUT_ITERATOR shall meet the requirements of an input iterator defined in the C++11 standard [24.2.3] providing access to values of a type convertible to value_type, and value_type must be emplace-constructible from *i into this multiset, where i is a dereferenceable iterator in the range [first .. last) (see {Requirements on KEY}). The behavior is undefined unless first and last refer to a sequence of valid values where first is at a position at or before last. Note that a bslma::Allocator * can be supplied for basicAllocator if the type ALLOCATOR is bsl::allocator (the default).

◆ multiset() [9/9]

template<class KEY , class COMPARATOR , class ALLOCATOR >

template<class INPUT_ITERATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::multiset	(	INPUT_ITERATOR	first,
		INPUT_ITERATOR	last,
		const ALLOCATOR &	basicAllocator
	)

inline

◆ ~multiset()

template<class KEY , class COMPARATOR , class ALLOCATOR >

bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::~multiset ( )

inline

Member Function Documentation

◆ begin() [1/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::begin ( )

inline

Return an iterator providing modifiable access to the first value_type object in the ordered sequence of value_type objects maintained by this multiset, or the end iterator if this multiset is empty.

◆ begin() [2/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::begin ( ) const

inline

Return an iterator providing non-modifiable access to the first value_type object in the ordered sequence of value_type objects maintained by this multiset, or the end iterator if this multiset is empty.

◆ cbegin()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::cbegin ( ) const

inline

Return an iterator providing non-modifiable access to the first value_type object in the ordered sequence of value_type objects maintained by this multiset, or the end iterator if this multiset is empty.

◆ cend()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::cend ( ) const

inline

Return an iterator providing non-modifiable access to the past-the-end element in the ordered sequence of value_type objects maintained by this multiset.

◆ contains() [1/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

bool bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::contains ( const key_type & key ) const

inline

Return true if this map contains an element whose key is equivalent to the specified key.

◆ contains() [2/2]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, bool >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::contains ( const LOOKUP_KEY & key ) const

inline

Return true if this map contains an element whose key is equivalent to the specified key.

Note: implemented inline due to Sun CC compilation error

◆ count() [1/2]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

size_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::count ( const key_type & key ) const

inline

Return the number of value_type objects within this multiset that are equivalent to the specified key.

Note: implemented inline due to Sun CC compilation error.

◆ count() [2/2]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, size_type >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::count ( const LOOKUP_KEY & key ) const

inline

Return the number of value_type objects within this multiset that are equivalent to the specified key.

Note: implemented inline due to Sun CC compilation error.

◆ crbegin()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::crbegin ( ) const

inline

Return a reverse iterator providing non-modifiable access to the last value_type object in the ordered sequence of value_type objects maintained by this multiset, or rend if this multiset is empty.

◆ crend()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::crend ( ) const

inline

Return a reverse iterator providing non-modifiable access to the prior-to-the-beginning element in the ordered sequence of value_type objects maintained by this multiset.

◆ emplace()

template<class KEY , class COMPARATOR , class ALLOCATOR >

template<class... Args>

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::emplace ( Args &&... args )

inline

Insert into this multiset a newly-created value_type object, constructed by forwarding get_allocator() (if required) and the specified (variable number of) args to the corresponding constructor of value_type. Return an iterator referring to the newly created and inserted object in this multiset. This method requires that the (template parameter) type KEY be emplace-constructible from args (see {Requirements on KEY}).

◆ emplace_hint()

template<class KEY , class COMPARATOR , class ALLOCATOR >

template<class... Args>

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::emplace_hint	(	const_iterator	hint,
		Args &&...	args
	)

inline

Insert into this multiset a newly-created value_type object, constructed by forwarding get_allocator() (if required) and the specified (variable number of) args to the corresponding constructor of value_type (in amortized constant time if the specified hint is a valid immediate successor to the value_type object constructed from args). Return an iterator referring to the newly created and inserted object in this multiset. If hint is not a valid immediate successor to the value_type object implied by args, this operation has O[log(N)] complexity where N is the size of this multiset. This method requires that the (template parameter) type KEY be emplace-constructible from args (see {Requirements on KEY}). The behavior is undefined unless hint is an iterator in the range [begin() .. end()] (both endpoints included).

◆ empty()

template<class KEY , class COMPARATOR , class ALLOCATOR >

bool bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::empty ( ) const

inline

Return true if this multiset contains no elements, and false otherwise.

◆ end() [1/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::end ( )

inline

Return an iterator providing modifiable access to the past-the-end element in the ordered sequence of value_type objects maintained by this multiset.

◆ end() [2/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::end ( ) const

inline

Return an iterator providing non-modifiable access to the past-the-end element in the ordered sequence of value_type objects maintained by this multiset.

◆ equal_range() [1/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

pair< iterator, iterator > bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::equal_range ( const key_type & key )

inline

Return a pair of iterators providing modifiable access to the sequence of value_type objects in this multiset equivalent to the specified key, where the first iterator is positioned at the start of the sequence and the second is positioned one past the end of the sequence. The first returned iterator will be lower_bound(key), the second returned iterator will be upper_bound(key), and, if this multiset contains no value_type objects with an equivalent key, then the two returned iterators will have the same value.

Note: implemented inline due to Sun CC compilation error.

◆ equal_range() [2/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

pair< const_iterator, const_iterator > bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::equal_range ( const key_type & key ) const

inline

Return a pair of iterators providing non-modifiable access to the sequence of value_type objects in this multiset that are equivalent to the specified key, where the first iterator is positioned at the start of the sequence, and the second is positioned one past the end of the sequence. The first returned iterator will be lower_bound(key); the second returned iterator will be upper_bound(key); and, if this multiset contains no value_type objects equivalent to key, then the two returned iterators will have the same value.

Note: implemented inline due to Sun CC compilation error.

◆ equal_range() [3/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, pair< iterator, iterator > >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::equal_range ( const LOOKUP_KEY & key )

inline

Return a pair of iterators providing modifiable access to the sequence of value_type objects in this multiset equivalent to the specified key, where the first iterator is positioned at the start of the sequence and the second is positioned one past the end of the sequence. The first returned iterator will be lower_bound(key), the second returned iterator will be upper_bound(key), and, if this multiset contains no value_type objects with an equivalent key, then the two returned iterators will have the same value.

Note: implemented inline due to Sun CC compilation error.

◆ equal_range() [4/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, pair< const_iterator, const_iterator > >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::equal_range ( const LOOKUP_KEY & key ) const

inline

Return a pair of iterators providing non-modifiable access to the sequence of value_type objects in this multiset that are equivalent to the specified key, where the first iterator is positioned at the start of the sequence, and the second is positioned one past the end of the sequence. The first returned iterator will be lower_bound(key); the second returned iterator will be upper_bound(key); and, if this multiset contains no value_type objects equivalent to key, then the two returned iterators will have the same value.

Note: implemented inline due to Sun CC compilation error.

◆ erase() [1/3]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::size_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::erase ( const key_type & key )

inline

Remove from this multiset all value_type objects equivalent to the specified key, if they exist, and return the number of erased objects; otherwise, if there are no value_type objects equivalent to key, return 0 with no other effect. This method invalidates only iterators and references to the removed element and previously saved values of the end() iterator.

◆ erase() [2/3]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::erase	(	const_iterator	first,
		const_iterator	last
	)

inline

◆ erase() [3/3]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::erase ( const_iterator position )

inline

Remove from this multiset the value_type object at the specified position, and return an iterator referring to the element immediately following the removed element, or to the past-the-end position if the removed element was the last element in the sequence of elements maintained by this multiset. This method invalidates only iterators and references to the removed element and previously saved values of the end() iterator. The behavior is undefined unless position refers to a value_type object in this multiset.

◆ find() [1/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::find ( const key_type & key )

inline

Return an iterator providing modifiable access to the first value_type object in this multiset equivalent to the specified key, if such an object exists, and the past-the-end (end) iterator otherwise.

Note: implemented inline due to Sun CC compilation error.

◆ find() [2/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::find ( const key_type & key ) const

inline

Return an iterator providing non-modifiable access to the first value_type object that is equivalent to the specified key in ordered sequence maintained by this multiset, if such an object exists, and the past-the-end (end) iterator otherwise.

Note: implemented inline due to Sun CC compilation error.

◆ find() [3/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::find ( const LOOKUP_KEY & key )

inline

Return an iterator providing modifiable access to the first value_type object in this multiset equivalent to the specified key, if such an object exists, and the past-the-end (end) iterator otherwise.

Note: implemented inline due to Sun CC compilation error.

◆ find() [4/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::find ( const LOOKUP_KEY & key ) const

inline

Return an iterator providing non-modifiable access to the first value_type object that is equivalent to the specified key in ordered sequence maintained by this multiset, if such an object exists, and the past-the-end (end) iterator otherwise.

Note: implemented inline due to Sun CC compilation error.

◆ get_allocator()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::allocator_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::get_allocator ( ) const

inline

Return (a copy of) the allocator used for memory allocation by this multiset.

◆ insert() [1/5]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::insert ( BloombergLP::bslmf::MovableRef< value_type > value )

inline

Insert the specified value into this multiset. If a range containing elements equivalent to value already exists in this multiset, insert value at the end of that range. value is left in a valid but unspecified state. Return an iterator referring to the newly inserted value_type object in this multiset that is equivalent to value. This method requires that the (template parameter) type KEY be move-insertable into this multiset (see {Requirements on KEY}).

◆ insert() [2/5]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::insert ( const value_type & value )

inline

Insert the specified value into this multiset. If a range containing elements equivalent to value already exists, insert the value at the end of that range. Return an iterator referring to the newly inserted value_type object. This method requires that the (template parameter) type KEY be copy-insertable into this multiset (see {Requirements on KEY}).

◆ insert() [3/5]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::insert	(	const_iterator	hint,
		BloombergLP::bslmf::MovableRef< value_type >	value
	)

inline

Insert the specified value into this multiset (in amortized constant time if the specified hint is a valid immediate successor to value). value is left in a valid but unspecified state. Return an iterator referring to the newly inserted value_type object in this multiset that is equivalent to value. If hint is not a valid immediate successor to value, this operation has O[log(N)] complexity, where N is the size of this multiset. This method requires that the (template parameter) type KEY be move-insertable into this multiset (see {Requirements on KEY}). The behavior is undefined unless hint is an iterator in the range [begin() .. end()] (both endpoints included).

◆ insert() [4/5]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::insert	(	const_iterator	hint,
		const value_type &	value
	)

inline

Insert the specified value into this multiset (in amortized constant time if the specified hint is a valid immediate successor to value). Return an iterator referring to the newly inserted value_type object in this multiset that is equivalent to value. If hint is not a valid immediate successor to value, this operation has O[log(N)] complexity, where N is the size of this multiset. This method requires that the (template parameter) type KEY be copy-insertable into this multiset (see {Requirements on KEY}). The behavior is undefined unless hint is an iterator in the range [begin() .. end()] (both endpoints included).

◆ insert() [5/5]

template<class KEY , class COMPARATOR , class ALLOCATOR >

template<class INPUT_ITERATOR >

void bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::insert	(	INPUT_ITERATOR	first,
		INPUT_ITERATOR	last
	)

inline

Insert into this multiset the value of each value_type object in the range starting at the specified first iterator and ending immediately before the specified last iterator. The (template parameter) type INPUT_ITERATOR shall meet the requirements of an input iterator defined in the C++11 standard [24.2.3] providing access to values of a type convertible to value_type, and value_type must be emplace-constructible from *i into this multiset, where i is a dereferenceable iterator in the range [first .. last) (see {Requirements on KEY}). The behavior is undefined unless first and last refer to a sequence of valid values where first is at a position at or before last.

Implementation Notes

◆ key_comp()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::key_compare bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::key_comp ( ) const

inline

Return the key-comparison functor (or function pointer) used by this multiset; if a comparator was supplied at construction, return its value, otherwise return a default constructed key_compare object. Note that this comparator compares objects of type KEY, which is the type of the value_type objects contained in this multiset.

◆ lower_bound() [1/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::lower_bound ( const key_type & key )

inline

Return an iterator providing modifiable access to the first (i.e., ordered least) value_type object in this multiset greater-than or equal-to the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than or equal-to key. Note that this function returns the first position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ lower_bound() [2/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::lower_bound ( const key_type & key ) const

inline

Return an iterator providing non-modifiable access to the first (i.e., ordered least) value_type object in this multiset greater-than or equal-to the specified key, and the past-the-end iterator if this multiset does not contain a value_type greater-than or equal-to key. Note that this function returns the first position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ lower_bound() [3/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::lower_bound ( const LOOKUP_KEY & key )

inline

Return an iterator providing modifiable access to the first (i.e., ordered least) value_type object in this multiset greater-than or equal-to the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than or equal-to key. Note that this function returns the first position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ lower_bound() [4/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::lower_bound ( const LOOKUP_KEY & key ) const

inline

Return an iterator providing non-modifiable access to the first (i.e., ordered least) value_type object in this multiset greater-than or equal-to the specified key, and the past-the-end iterator if this multiset does not contain a value_type greater-than or equal-to key. Note that this function returns the first position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ max_size()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::size_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::max_size ( ) const

inline

Return a theoretical upper bound on the largest number of elements that this multiset could possibly hold. Note that there is no guarantee that the multiset can successfully grow to the returned size, or even close to that size without running out of resources.

◆ operator=()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR > & bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::operator= ( const multiset< KEY, COMPARATOR, ALLOCATOR > & rhs )

inline

Assign to this object the value and comparator of the specified rhs object, propagate to this object the allocator of rhs if the ALLOCATOR type has trait propagate_on_container_copy_assignment, and return a reference providing modifiable access to this object. If an exception is thrown, *this is left in a valid but unspecified state. This method requires that the (template parameter) type KEY be copy-assignable and copy-insertable into this multiset (see {Requirements on KEY}).

◆ rbegin() [1/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::rbegin ( )

inline

Return a reverse iterator providing modifiable access to the last value_type object in the ordered sequence of value_type objects maintained by this multiset, or rend if this multiset is empty.

◆ rbegin() [2/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::rbegin ( ) const

inline

Return a reverse iterator providing non-modifiable access to the last value_type object in the ordered sequence of value_type objects maintained by this multiset, or rend if this multiset is empty.

◆ rend() [1/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::rend ( )

inline

Return a reverse iterator providing modifiable access to the prior-to-the-beginning element in the ordered sequence of value_type objects maintained by this multiset.

◆ rend() [2/2]

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::const_reverse_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::rend ( ) const

inline

Return a reverse iterator providing non-modifiable access to the prior-to-the-beginning element in the ordered sequence of value_type objects maintained by this multiset.

◆ size()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::size_type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::size ( ) const

inline

◆ upper_bound() [1/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::upper_bound ( const key_type & key )

inline

Return an iterator providing modifiable access to the first (i.e., ordered least) value_type object in this multiset greater than the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than key. Note that this function returns the last position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ upper_bound() [2/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

const_iterator bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::upper_bound ( const key_type & key ) const

inline

Return an iterator providing non-modifiable access to the first (i.e., ordered least) value_type object in this multiset greater than the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than key. Note that this function returns the last position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ upper_bound() [3/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::upper_bound ( const LOOKUP_KEY & key )

inline

Return an iterator providing modifiable access to the first (i.e., ordered least) value_type object in this multiset greater than the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than key. Note that this function returns the last position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ upper_bound() [4/4]

template<class KEY , class COMPARATOR = std::less<KEY>, class ALLOCATOR = bsl::allocator<KEY>>

template<class LOOKUP_KEY >

bsl::enable_if< BloombergLP::bslmf::IsTransparentPredicate< COMPARATOR, LOOKUP_KEY >::value, const_iterator >::type bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::upper_bound ( const LOOKUP_KEY & key ) const

inline

Return an iterator providing non-modifiable access to the first (i.e., ordered least) value_type object in this multiset greater than the specified key, and the past-the-end iterator if this multiset does not contain a value_type object greater-than key. Note that this function returns the last position before which a value_type object equivalent to key could be inserted into the ordered sequence maintained by this multiset, while preserving its ordering.

Note: implemented inline due to Sun CC compilation error.

◆ value_comp()

template<class KEY , class COMPARATOR , class ALLOCATOR >

multiset< KEY, COMPARATOR, ALLOCATOR >::value_compare bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::value_comp ( ) const

inline

Return a functor for comparing two value_type objects using key_comp(). Note that since value_type is an alias to KEY for multiset, this method returns the same functor as key_comp().

Member Data Documentation

◆ clear

template<class KEY , class COMPARATOR , class ALLOCATOR >

void bsl::multiset< KEY, COMPARATOR, ALLOCATOR >::clear

inline

Remove from this multiset the value_type objects starting at the specified first position up to, but not including the specified last position, and return last. This method invalidates only iterators and references to the removed element and previously saved values of the end() iterator. The behavior is undefined unless first and last either refer to elements in this multiset or are the end iterator, and the first position is at or before the last position in the ordered sequence provided by this container. Remove all entries from this multiset. Note that the multiset is empty after this call, but allocated memory may be retained for future use.

The documentation for this class was generated from the following file:

bslstl_multiset.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ key_compare

◆ key_type

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_compare

◆ value_type

Constructor & Destructor Documentation

◆ multiset() [1/9]

◆ multiset() [2/9]

◆ multiset() [3/9]

◆ multiset() [4/9]

◆ multiset() [5/9]

◆ multiset() [6/9]

◆ multiset() [7/9]

◆ multiset() [8/9]

◆ multiset() [9/9]

◆ ~multiset()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ contains() [1/2]

◆ contains() [2/2]

◆ count() [1/2]

◆ count() [2/2]

◆ crbegin()

◆ crend()

◆ emplace()

◆ emplace_hint()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ equal_range() [1/4]

◆ equal_range() [2/4]

◆ equal_range() [3/4]

◆ equal_range() [4/4]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ find() [1/4]

◆ find() [2/4]

◆ find() [3/4]

◆ find() [4/4]

◆ get_allocator()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

Implementation Notes

◆ key_comp()

◆ lower_bound() [1/4]

◆ lower_bound() [2/4]

◆ lower_bound() [3/4]

◆ lower_bound() [4/4]

◆ max_size()

◆ operator=()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size()

◆ upper_bound() [1/4]

◆ upper_bound() [2/4]

◆ upper_bound() [3/4]