CARVIEW |
Select Language
HTTP/1.1 301 Moved Permanently
Server: nginx
Date: Sat, 19 Jul 2025 10:46:08 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Location: /reference/map/map/emplace_hint/
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 19 Jul 2025 10:46:08 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
ETag: W/"82f2-aKULAbbYmcBWzdmlr5JZVwkkoZE"
Content-Encoding: gzip
Inserts a new element in the map if its key is unique, with a hint on the insertion position. This new element is constructed in place using args as the arguments for the construction of a value_type (which is an object of a pair type).
The insertion only takes place if no other element in the container has a key equivalent to the one being emplaced (elements in a map container are unique).
If inserted, this effectively increases the container size by one.
The value in position is used as a hint on the insertion point. The element will nevertheless be inserted at its corresponding position following the order described by its internal comparison object, but this hint is used by the function to begin its search for the insertion point, speeding up the process considerably when the actual insertion point is either position or close to it.
The element is constructed in-place by calling allocator_traits::construct with args forwarded.
Otherwise, it returns an iterator to the equivalent element within the container.
Member type iterator is a bidirectional iterator type that points to an element.
Output:
Amortized constant if the insertion point for the element is position.
Concurrently accessing existing elements is safe, although iterating ranges in the container is not.
If allocator_traits::construct is not supported with the appropriate arguments, it causes undefined behavior.
Reference
C library:
- <cassert> (assert.h)
- <cctype> (ctype.h)
- <cerrno> (errno.h)
-
<cfenv> (fenv.h)C++11
- <cfloat> (float.h)
-
<cinttypes> (inttypes.h)C++11
- <ciso646> (iso646.h)
- <climits> (limits.h)
- <clocale> (locale.h)
- <cmath> (math.h)
- <csetjmp> (setjmp.h)
- <csignal> (signal.h)
- <cstdarg> (stdarg.h)
-
<cstdbool> (stdbool.h)C++11
- <cstddef> (stddef.h)
-
<cstdint> (stdint.h)C++11
- <cstdio> (stdio.h)
- <cstdlib> (stdlib.h)
- <cstring> (string.h)
-
<ctgmath> (tgmath.h)C++11
- <ctime> (time.h)
-
<cuchar> (uchar.h)C++11
- <cwchar> (wchar.h)
- <cwctype> (wctype.h)
Containers:
-
<array>C++11
- <deque>
-
<forward_list>C++11
- <list>
- <map>
- <queue>
- <set>
- <stack>
-
<unordered_map>C++11
-
<unordered_set>C++11
- <vector>
-
Input/Output:
Multi-threading:
-
<atomic>C++11
-
<condition_variable>C++11
-
<future>C++11
-
<mutex>C++11
-
<thread>C++11
-
Other:
- <algorithm>
- <bitset>
-
<chrono>C++11
-
<codecvt>C++11
- <complex>
- <exception>
- <functional>
-
<initializer_list>C++11
- <iterator>
- <limits>
- <locale>
- <memory>
- <new>
- <numeric>
-
<random>C++11
-
<ratio>C++11
-
<regex>C++11
- <stdexcept>
- <string>
-
<system_error>C++11
-
<tuple>C++11
-
<type_traits>C++11
-
<typeindex>C++11
- <typeinfo>
- <utility>
- <valarray>
map
- map::~map
- map::map
member functions
-
map::atC++11
- map::begin
-
map::cbeginC++11
-
map::cendC++11
- map::clear
- map::count
-
map::crbeginC++11
-
map::crendC++11
-
map::emplaceC++11
-
map::emplace_hintC++11
- map::empty
- map::end
- map::equal_range
- map::erase
- map::find
- map::get_allocator
- map::insert
- map::key_comp
- map::lower_bound
- map::max_size
- map::operator[]
- map::operator=
- map::rbegin
- map::rend
- map::size
- map::swap
- map::upper_bound
- map::value_comp
-
non-member overloads
public member function
<map>
std::map::emplace_hint
template <class... Args> iterator emplace_hint (const_iterator position, Args&&... args);
Construct and insert element with hint
The insertion only takes place if no other element in the container has a key equivalent to the one being emplaced (elements in a map container are unique).
If inserted, this effectively increases the container size by one.
The value in position is used as a hint on the insertion point. The element will nevertheless be inserted at its corresponding position following the order described by its internal comparison object, but this hint is used by the function to begin its search for the insertion point, speeding up the process considerably when the actual insertion point is either position or close to it.
The element is constructed in-place by calling allocator_traits::construct with args forwarded.
Parameters
- position
- Hint for the position where the element can be inserted.
The function optimizes its insertion time if position points to the element that will follow the inserted element (or to the end, if it would be the last).
Notice that this does not force the new element to be in that position within the map container (the elements in a map always follow a specific order).
const_iterator is a member type, defined as a bidirectional iterator type that points to elements. - args
- Arguments used to construct a new object of the mapped type for the inserted element.
Arguments forwarded to construct the new element (of typepair<const key_type, mapped_type>
).
This can be one of:
- Two arguments: one for the key, the other for the mapped value.
- A single argument of apair
type with a value for the key as first member, and a value for the mapped value as second.
- piecewise_construct as first argument, and two additional arguments with tuples to be forwarded as arguments for the key value and for the mapped value respectivelly.
See pair::pair for more info.
Return value
If the function successfully inserts the element (because no equivalent element existed already in the map), the function returns an iterator to the newly inserted element.Otherwise, it returns an iterator to the equivalent element within the container.
Member type iterator is a bidirectional iterator type that points to an element.
Example
|
|
mymap contains: [a:12] [b:10] [c:14] |
Complexity
Generally, logarithmic in the container size.Amortized constant if the insertion point for the element is position.
Iterator validity
No changes.Data races
The container is modified.Concurrently accessing existing elements is safe, although iterating ranges in the container is not.
Exception safety
Strong guarantee: if an exception is thrown, there are no changes in the container.If allocator_traits::construct is not supported with the appropriate arguments, it causes undefined behavior.
See also
- map::emplace
- Construct and insert element (public member function)
- map::insert
- Insert elements (public member function)
- map::erase
- Erase elements (public member function)
Home page | Privacy policy
© cplusplus.com, 2000-2025 - All rights reserved - v3.3.4s
Spotted an error? contact us
© cplusplus.com, 2000-2025 - All rights reserved - v3.3.4s
Spotted an error? contact us