Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QHash< Key, T >::const_iterator Class Reference

\inmodule QtCore More...

#include <qhash.h>

+ Collaboration diagram for QHash< Key, T >::const_iterator:

Public Types

typedef std::forward_iterator_tag iterator_category
 
typedef qptrdiff difference_type
 
typedef T value_type
 
typedef const T * pointer
 
typedef const T & reference
 

Public Member Functions

constexpr const_iterator () noexcept=default
 Constructs an uninitialized iterator.
 
 const_iterator (const iterator &o) noexcept
 Constructs a copy of other.
 
const Keykey () const noexcept
 Returns the current item's key.
 
const T & value () const noexcept
 Returns the current item's value.
 
const T & operator* () const noexcept
 Returns the current item's value.
 
const T * operator-> () const noexcept
 Returns a pointer to the current item's value.
 
bool operator== (const const_iterator &o) const noexcept
 Returns true if other points to the same item as this iterator; otherwise returns false.
 
bool operator!= (const const_iterator &o) const noexcept
 Returns true if other points to a different item than this iterator; otherwise returns false.
 
const_iteratoroperator++ () noexcept
 The prefix ++ operator ({++i}) advances the iterator to the next item in the hash and returns an iterator to the new current item.
 
const_iterator operator++ (int) noexcept
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix ++ operator ({i++}) advances the iterator to the next item in the hash and returns an iterator to the previously current item.
 

Friends

class iterator
 
class QHash< Key, T >
 
class QSet< Key >
 

Detailed Description

template<typename Key, typename T>
class QHash< Key, T >::const_iterator

\inmodule QtCore

The QHash::const_iterator class provides an STL-style const iterator for QHash.

QHash<Key, T>const_iterator allows you to iterate over a QHash. If you want to modify the QHash as you iterate over it, you must use QHash::iterator instead. It is generally good practice to use QHash::const_iterator on a non-const QHash as well, unless you need to change the QHash through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QHash::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QHash function like QHash::cbegin(), QHash::cend(), or QHash::constFind() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a hash:

hash.insert("January", 1);
hash.insert("February", 2);
...
hash.insert("December", 12);
for (auto i = hash.cbegin(), end = hash.cend(); i != end; ++i)
cout << qPrintable(i.key()) << ": " << i.value() << endl;

Unlike QMap, which orders its items by key, QHash stores its items in an arbitrary order. The only guarantee is that items that share the same key (because they were inserted using a QMultiHash) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same hash. However, be aware that any modification performed directly on the QHash (inserting and removing items) can cause the iterators to become invalid.

Inserting items into the hash or calling methods such as QHash::reserve() or QHash::squeeze() can invalidate all iterators pointing into the hash. Iterators are guaranteed to stay valid only as long as the QHash doesn't have to grow/shrink its internal hash table. Using any iterator after a rehashing operation has occurred will lead to undefined behavior.

You can however safely use iterators to remove entries from the hash using the QHash::erase() method. This function can safely be called while iterating, and won't affect the order of items in the hash.

Warning
Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read \l{Implicit sharing iterator problem}.
See also
QHash::iterator, QHash::key_iterator, QHash::const_key_value_iterator

Definition at line 1169 of file qhash.h.

Member Typedef Documentation

◆ difference_type

template<typename Key , typename T >
qptrdiff QHash< Key, T >::const_iterator::difference_type

Definition at line 1180 of file qhash.h.

◆ iterator_category

template<typename Key , typename T >
std::forward_iterator_tag QHash< Key, T >::const_iterator::iterator_category

Definition at line 1179 of file qhash.h.

◆ pointer

template<typename Key , typename T >
const T* QHash< Key, T >::const_iterator::pointer

Definition at line 1182 of file qhash.h.

◆ reference

template<typename Key , typename T >
const T& QHash< Key, T >::const_iterator::reference

Definition at line 1183 of file qhash.h.

◆ value_type

template<typename Key , typename T >
T QHash< Key, T >::const_iterator::value_type

Definition at line 1181 of file qhash.h.

Constructor & Destructor Documentation

◆ const_iterator() [1/2]

template<typename Key , typename T >
QHash< Key, T >::const_iterator::const_iterator ( )
constexprdefaultnoexcept

Constructs an uninitialized iterator.

Functions like key(), value(), and operator++() must not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See also
QHash::constBegin(), QHash::constEnd()

◆ const_iterator() [2/2]

template<typename Key , typename T >
QHash< Key, T >::const_iterator::const_iterator ( const iterator & o)
inlinenoexcept

Constructs a copy of other.

Definition at line 1186 of file qhash.h.

Member Function Documentation

◆ key()

template<typename Key , typename T >
const Key & QHash< Key, T >::const_iterator::key ( ) const
inlinenoexcept

Returns the current item's key.

See also
value()

Definition at line 1188 of file qhash.h.

◆ operator!=()

template<typename Key , typename T >
bool QHash< Key, T >::const_iterator::operator!= ( const const_iterator & other) const
inlinenoexcept

Returns true if other points to a different item than this iterator; otherwise returns false.

See also
operator==()

Definition at line 1193 of file qhash.h.

◆ operator*()

template<typename Key , typename T >
const T & QHash< Key, T >::const_iterator::operator* ( ) const
inlinenoexcept

Returns the current item's value.

Same as value().

See also
key()

Definition at line 1190 of file qhash.h.

◆ operator++() [1/2]

template<typename Key , typename T >
const_iterator & QHash< Key, T >::const_iterator::operator++ ( )
inlinenoexcept

The prefix ++ operator ({++i}) advances the iterator to the next item in the hash and returns an iterator to the new current item.

Calling this function on QHash::end() leads to undefined results.

Definition at line 1195 of file qhash.h.

◆ operator++() [2/2]

template<typename Key , typename T >
const_iterator QHash< Key, T >::const_iterator::operator++ ( int )
inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix ++ operator ({i++}) advances the iterator to the next item in the hash and returns an iterator to the previously current item.

Definition at line 1200 of file qhash.h.

◆ operator->()

template<typename Key , typename T >
const T * QHash< Key, T >::const_iterator::operator-> ( ) const
inlinenoexcept

Returns a pointer to the current item's value.

See also
value()

Definition at line 1191 of file qhash.h.

◆ operator==()

template<typename Key , typename T >
bool QHash< Key, T >::const_iterator::operator== ( const const_iterator & other) const
inlinenoexcept

Returns true if other points to the same item as this iterator; otherwise returns false.

See also
operator!=()

Definition at line 1192 of file qhash.h.

◆ value()

template<typename Key , typename T >
const T & QHash< Key, T >::const_iterator::value ( ) const
inlinenoexcept

Returns the current item's value.

See also
key(), operator*()

Definition at line 1189 of file qhash.h.

Friends And Related Symbol Documentation

◆ iterator

template<typename Key , typename T >
friend class iterator
friend

Definition at line 1172 of file qhash.h.

◆ QHash< Key, T >

template<typename Key , typename T >
friend class QHash< Key, T >
friend

Definition at line 1172 of file qhash.h.

◆ QSet< Key >

template<typename Key , typename T >
friend class QSet< Key >
friend

Definition at line 1172 of file qhash.h.


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