Movatterモバイル変換


[0]ホーム

URL:


cppreference.com
Namespaces
Variants
    Actions

      std::unordered_set

      From cppreference.com
      <cpp‎ |container
       
       
       
      std::unordered_set
      Member types
      Member functions
      Non-member functions
      Deduction guides(C++17)
       
      Defined in header<unordered_set>
      template<

         class Key,
         class Hash=std::hash<Key>,
         class KeyEqual=std::equal_to<Key>,
         class Allocator=std::allocator<Key>

      >class unordered_set;
      (1)(since C++11)
      namespace pmr{

         template<
             class Key,
             class Hash=std::hash<Key>,
             class Pred=std::equal_to<Key>
         >using unordered_set= std::unordered_set<Key, Hash, Pred,
                                     std::pmr::polymorphic_allocator<Key>>;

      }
      (2)(since C++17)

      std::unordered_set is an associative container that contains a set of unique objects of typeKey. Search, insertion, and removal have average constant-time complexity.

      Internally, the elements are not sorted in any particular order, but organized into buckets. Which bucket an element is placed into depends entirely on the hash of its value. This allows fast access to individual elements, since once a hash is computed, it refers to the exact bucket the element is placed into.

      Container elements may not be modified (even by non const iterators) since modification could change an element's hash and corrupt the container.

      std::unordered_set meets the requirements ofContainer,AllocatorAwareContainer,UnorderedAssociativeContainer.

      All member functions ofstd::unordered_set areconstexpr: it is possible to create and usestd::unordered_set objects in the evaluation of a constant expression.

      However,std::unordered_set objects generally cannot beconstexpr, because any dynamically allocated storage must be released in the same evaluation of constant expression.

      (since C++26)

      Contents

      [edit]Iterator invalidation

      OperationsInvalidated
      All read only operations,swap,std::swapNever
      clear,rehash,reserve,operator=Always
      insert,emplace,emplace_hintOnly if causes rehash
      eraseOnly to the element erased

      [edit]Notes

      • The swap functions do not invalidate any of the iterators inside the container, but they do invalidate the iterator marking the end of the swap region.
      • References and pointers to data stored in the container are only invalidated by erasing that element, even when the corresponding iterator is invalidated.
      • After container move assignment, unless elementwise move assignment is forced by incompatible allocators, references, pointers, and iterators (other than the past-the-end iterator) to moved-from container remain valid, but refer to elements that are now in*this.

      [edit]Template parameters

      This section is incomplete
      Reason: Add descriptions of the template parameters.

      [edit]Member types

      Type Definition
      key_typeKey[edit]
      value_typeKey[edit]
      size_type Unsigned integer type (usuallystd::size_t)[edit]
      difference_type Signed integer type (usuallystd::ptrdiff_t)[edit]
      hasherHash[edit]
      key_equalKeyEqual[edit]
      allocator_typeAllocator[edit]
      referencevalue_type&[edit]
      const_referenceconst value_type&[edit]
      pointerstd::allocator_traits<Allocator>::pointer[edit]
      const_pointerstd::allocator_traits<Allocator>::const_pointer[edit]
      iterator ConstantLegacyForwardIterator andConstexprIterator(since C++26) tovalue_type[edit]
      const_iteratorLegacyForwardIterator andConstexprIterator(since C++26) toconst value_type[edit]
      local_iterator An iterator type whose category, value, difference, pointer and
      reference types are the same asiterator. This iterator
      can be used to iterate through a single bucket but not across buckets[edit]
      const_local_iterator An iterator type whose category, value, difference, pointer and
      reference types are the same asconst_iterator. This iterator
      can be used to iterate through a single bucket but not across buckets[edit]
      node_type(since C++17) a specialization ofnode handle representing a container node[edit]
      insert_return_type(since C++17) type describing the result of inserting anode_type, a specialization of

      template<class Iter,class NodeType>
      struct/*unspecified*/
      {
          Iter     position;
         bool     inserted;
          NodeType node;
      };

      instantiated with template argumentsiterator andnode_type.[edit]

      [edit]Member functions

      constructs theunordered_set
      (public member function)[edit]
      destructs theunordered_set
      (public member function)[edit]
      assigns values to the container
      (public member function)[edit]
      returns the associated allocator
      (public member function)[edit]
      Iterators
      returns an iterator to the beginning
      (public member function)[edit]
      returns an iterator to the end
      (public member function)[edit]
      Capacity
      checks whether the container is empty
      (public member function)[edit]
      returns the number of elements
      (public member function)[edit]
      returns the maximum possible number of elements
      (public member function)[edit]
      Modifiers
      clears the contents
      (public member function)[edit]
      inserts elementsor nodes(since C++17)
      (public member function)[edit]
      inserts a range of elements
      (public member function)[edit]
      constructs element in-place
      (public member function)[edit]
      constructs elements in-place using a hint
      (public member function)[edit]
      erases elements
      (public member function)[edit]
      swaps the contents
      (public member function)[edit]
      (C++17)
      extracts nodes from the container
      (public member function)[edit]
      (C++17)
      splices nodes from another container
      (public member function)[edit]
      Lookup
      returns the number of elements matching specific key
      (public member function)[edit]
      finds element with specific key
      (public member function)[edit]
      (C++20)
      checks if the container contains element with specific key
      (public member function)[edit]
      returns range of elements matching a specific key
      (public member function)[edit]
      Bucket interface
      returns an iterator to the beginning of the specified bucket
      (public member function)[edit]
      returns an iterator to the end of the specified bucket
      (public member function)[edit]
      returns the number of buckets
      (public member function)[edit]
      returns the maximum number of buckets
      (public member function)[edit]
      returns the number of elements in specific bucket
      (public member function)[edit]
      returns the bucket for specific key
      (public member function)[edit]
      Hash policy
      returns average number of elements per bucket
      (public member function)[edit]
      manages maximum average number of elements per bucket
      (public member function)[edit]
      reserves at least the specified number of buckets and regenerates the hash table
      (public member function)[edit]
      reserves space for at least the specified number of elements and regenerates the hash table
      (public member function)[edit]
      Observers
      returns function used to hash the keys
      (public member function)[edit]
      returns the function used to compare keys for equality
      (public member function)[edit]

      [edit]Non-member functions

      (C++11)(C++11)(removed in C++20)
      compares the values in the unordered_set
      (function template)[edit]
      specializes thestd::swap algorithm
      (function template)[edit]
      erases all elements satisfying specific criteria
      (function template)[edit]

      Deduction guides

      (since C++17)

      [edit]Notes

      The member typesiterator andconst_iterator may be aliases to the same type. This means defining a pair of function overloads using the two types as parameter types may violate theOne Definition Rule. Sinceiterator is convertible toconst_iterator, a single function with aconst_iterator as parameter type will work instead.

      Feature-test macroValueStdFeature
      __cpp_lib_containers_ranges202202L(C++23)Ranges construction and insertion for containers
      __cpp_lib_constexpr_unordered_set202502L(C++26)constexprstd::unordered_set

      [edit]Example

      Run this code
      #include <iostream>#include <unordered_set> void print(constauto& set){for(constauto& elem: set)std::cout<< elem<<' ';std::cout<<'\n';} int main(){    std::unordered_set<int> mySet{2,7,1,8,2,8};// creates a set of ints    print(mySet);     mySet.insert(5);// puts an element 5 in the set    print(mySet); if(auto iter= mySet.find(5); iter!= mySet.end())        mySet.erase(iter);// removes an element pointed to by iter    print(mySet);     mySet.erase(7);// removes an element 7    print(mySet);}

      Possible output:

      8 1 7 25 8 1 7 28 1 7 28 1 2

      [edit]Defect reports

      The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

      DRApplied toBehavior as publishedCorrect behavior
      LWG 2050C++11the definitions ofreference,const_reference,pointer
      andconst_pointer were based onallocator_type
      based onvalue_type and
      std::allocator_traits

      [edit]See also

      collection of keys, hashed by keys
      (class template)[edit]
      collection of unique keys, sorted by keys
      (class template)[edit]
      (C++23)
      adapts a container to provide a collection of unique keys, sorted by keys
      (class template)[edit]
      Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/unordered_set&oldid=182874"

      [8]ページ先頭

      ©2009-2025 Movatter.jp