Qt 4.8
Public Types | Public Functions | Public Variables | List of all members
QLinkedList< T >::iterator Class Reference

The QLinkedList::iterator class provides an STL-style non-const iterator for QLinkedList. More...

#include <qlinkedlist.h>

Public Types

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

Public Functions

 iterator ()
 Constructs an uninitialized iterator. More...
 
 iterator (Node *n)
 
 iterator (const iterator &o)
 Constructs a copy of other. More...
 
bool operator!= (const iterator &o) const
 Returns true if other points to a different item than this iterator; otherwise returns false. More...
 
bool operator!= (const const_iterator &o) const
 
T & operator* () const
 Returns a modifiable reference to the current item. More...
 
iterator operator+ (int j) const
 Returns an iterator to the item at j positions forward from this iterator. More...
 
iteratoroperator++ ()
 The prefix ++ operator (++it) advances the iterator to the next item in the list and returns an iterator to the new current item. More...
 
iterator operator++ (int)
 The postfix ++ operator (it++) advances the iterator to the next item in the list and returns an iterator to the previously current item. More...
 
iteratoroperator+= (int j)
 Advances the iterator by j items. More...
 
iterator operator- (int j) const
 Returns an iterator to the item at j positions backward from this iterator. More...
 
iteratoroperator-- ()
 The prefix – operator (–it) makes the preceding item current and returns an iterator to the new current item. More...
 
iterator operator-- (int)
 The postfix – operator (it–) makes the preceding item current and returns an iterator to the previously current item. More...
 
iteratoroperator-= (int j)
 Makes the iterator go back by j items. More...
 
T * operator-> () const
 Returns a pointer to the current item. More...
 
iteratoroperator= (const iterator &o)
 Assigns other to this iterator. More...
 
bool operator== (const iterator &o) const
 Returns true if other points to the same item as this iterator; otherwise returns false. More...
 
bool operator== (const const_iterator &o) const
 

Public Variables

Nodei
 

Detailed Description

template<class T>
class QLinkedList< T >::iterator

The QLinkedList::iterator class provides an STL-style non-const iterator for QLinkedList.

QLinkedList features both STL-style iterators and Java-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

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

The default QLinkedList::iterator constructor creates an uninitialized iterator. You must initialize it using a function like QLinkedList::begin(), QLinkedList::end(), or QLinkedList::insert() before you can start iterating. Here's a typical loop that prints all the items stored in a list:

list.append("January");
list.append("February");
...
list.append("December");
for (i = list.begin(); i != list.end(); ++i)
cout << *i << endl;

STL-style iterators can be used as arguments to generic algorithms. For example, here's how to find an item in the list using the qFind() algorithm:

...
list.end(), "Joel");
if (it != list.end())
cout << "Found Joel" << endl;

Let's see a few examples of things we can do with a QLinkedList::iterator that we cannot do with a QLinkedList::const_iterator. Here's an example that increments every value stored in a QLinkedList<int> by 2:

for (i = list.begin(); i != list.end(); ++i)
*i += 2;

Here's an example that removes all the items that start with an underscore character in a QLinkedList<QString>:

...
while (i != list.end()) {
if ((*i).startsWith("_"))
i = list.erase(i);
else
++i;
}

The call to QLinkedList::erase() removes the item pointed to by the iterator from the list, and returns an iterator to the next item. Here's another way of removing an item while iterating:

while (i != list.end()) {
++i;
if ((*previous).startsWith("_"))
list.erase(previous);
}

It might be tempting to write code like this:

// WRONG
while (i != list.end()) {
if ((*i).startsWith("_"))
list.erase(i);
++i;
}

However, this will potentially crash in ++i, because i is a dangling iterator after the call to erase().

Multiple iterators can be used on the same list. If you add items to the list, existing iterators will remain valid. If you remove items from the list, iterators that point to the removed items will become dangling iterators. However, because of how implicit sharing works, you must not take a copy of a container while iterators are active on that container.

See also
QLinkedList::const_iterator, QMutableLinkedListIterator

Definition at line 118 of file qlinkedlist.h.

Typedefs

◆ difference_type

template<class T>
QLinkedList< T >::iterator::difference_type
Warning
This function is not part of the public interface.

Definition at line 122 of file qlinkedlist.h.

◆ iterator_category

template<class T>
QLinkedList< T >::iterator::iterator_category
Warning
This function is not part of the public interface.

Definition at line 121 of file qlinkedlist.h.

◆ pointer

template<class T>
QLinkedList< T >::iterator::pointer
Warning
This function is not part of the public interface.

Definition at line 124 of file qlinkedlist.h.

◆ reference

template<class T>
QLinkedList< T >::iterator::reference
Warning
This function is not part of the public interface.

Definition at line 125 of file qlinkedlist.h.

◆ value_type

template<class T>
QLinkedList< T >::iterator::value_type
Warning
This function is not part of the public interface.

Definition at line 123 of file qlinkedlist.h.

Constructors and Destructors

◆ iterator() [1/3]

template<class T>
QLinkedList< T >::iterator::iterator ( )
inline

Constructs an uninitialized iterator.

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

See also
QLinkedList::begin() QLinkedList::end()

Definition at line 127 of file qlinkedlist.h.

127 : i(0) {}

◆ iterator() [2/3]

template<class T>
QLinkedList< T >::iterator::iterator ( Node node)
inline
Warning
This function is not part of the public interface.

Definition at line 128 of file qlinkedlist.h.

128 : i(n) {}

◆ iterator() [3/3]

template<class T>
QLinkedList< T >::iterator::iterator ( const iterator o)
inline

Constructs a copy of other.

Definition at line 129 of file qlinkedlist.h.

129 : i(o.i) {}

Functions

◆ operator!=() [1/2]

template<class T>
bool QLinkedList< T >::iterator::operator!= ( const iterator o) const
inline

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

Definition at line 134 of file qlinkedlist.h.

134 { return i != o.i; }

◆ operator!=() [2/2]

template<class T>
bool QLinkedList< T >::iterator::operator!= ( const const_iterator other) const
inline
See also
operator==()

Definition at line 137 of file qlinkedlist.h.

138  { return i != o.i; }

◆ operator*()

template<class T>
T & QLinkedList< T >::iterator::operator* ( ) const
inline

Returns a modifiable reference to the current item.

You can change the value of an item by using operator*() on the left side of an assignment, for example:

if (*it == "Hello")
*it = "Bonjour";
See also
operator->()

Definition at line 131 of file qlinkedlist.h.

131 { return i->t; }

◆ operator+()

template<class T>
QLinkedList::iterator QLinkedList< T >::iterator::operator+ ( int  j) const
inline

Returns an iterator to the item at j positions forward from this iterator.

(If j is negative, the iterator goes backward.)

This operation can be slow for large j values.

See also
operator-()

Definition at line 143 of file qlinkedlist.h.

144  { Node *n = i; if (j > 0) while (j--) n = n->n; else while (j++) n = n->p; return n; }

◆ operator++() [1/2]

template<class T>
QLinkedList::iterator & QLinkedList< T >::iterator::operator++ ( )
inline

The prefix ++ operator (++it) advances the iterator to the next item in the list and returns an iterator to the new current item.

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

See also
operator--()

Definition at line 139 of file qlinkedlist.h.

139 { i = i->n; return *this; }
QLinkedListNode * n
Definition: qlinkedlist.h:73

◆ operator++() [2/2]

template<class T>
QLinkedList::iterator QLinkedList< T >::iterator::operator++ ( int  )
inline

The postfix ++ operator (it++) advances the iterator to the next item in the list and returns an iterator to the previously current item.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 140 of file qlinkedlist.h.

140 { Node *n = i; i = i->n; return n; }
QLinkedListNode * n
Definition: qlinkedlist.h:73

◆ operator+=()

template<class T>
QLinkedList::iterator & QLinkedList< T >::iterator::operator+= ( int  j)
inline

Advances the iterator by j items.

(If j is negative, the iterator goes backward.)

See also
operator-=(), operator+()

Definition at line 146 of file qlinkedlist.h.

146 { return *this = *this + j; }

◆ operator-()

template<class T>
QLinkedList::iterator QLinkedList< T >::iterator::operator- ( int  j) const
inline

Returns an iterator to the item at j positions backward from this iterator.

(If j is negative, the iterator goes forward.)

This operation can be slow for large j values.

See also
operator+()

Definition at line 145 of file qlinkedlist.h.

145 { return operator+(-j); }
iterator operator+(int j) const
Returns an iterator to the item at j positions forward from this iterator.
Definition: qlinkedlist.h:143

◆ operator--() [1/2]

template<class T>
QLinkedList::iterator & QLinkedList< T >::iterator::operator-- ( )
inline

The prefix – operator (–it) makes the preceding item current and returns an iterator to the new current item.

Calling this function on QLinkedList::begin() leads to undefined results.

See also
operator++()

Definition at line 141 of file qlinkedlist.h.

141 { i = i->p; return *this; }
QLinkedListNode * p
Definition: qlinkedlist.h:73

◆ operator--() [2/2]

template<class T>
QLinkedList::iterator QLinkedList< T >::iterator::operator-- ( int  )
inline

The postfix – operator (it–) makes the preceding item current and returns an iterator to the previously current item.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 142 of file qlinkedlist.h.

142 { Node *n = i; i = i->p; return n; }
QLinkedListNode * p
Definition: qlinkedlist.h:73

◆ operator-=()

template<class T>
QLinkedList::iterator & QLinkedList< T >::iterator::operator-= ( int  j)
inline

Makes the iterator go back by j items.

(If j is negative, the iterator goes forward.)

See also
operator+=(), operator-()

Definition at line 147 of file qlinkedlist.h.

147 { return *this = *this - j; }

◆ operator->()

template<class T>
T * QLinkedList< T >::iterator::operator-> ( ) const
inline

Returns a pointer to the current item.

See also
operator*()

Definition at line 132 of file qlinkedlist.h.

132 { return &i->t; }

◆ operator=()

template<class T>
QLinkedList::iterator & QLinkedList< T >::iterator::operator= ( const iterator o)
inline

Assigns other to this iterator.

Definition at line 130 of file qlinkedlist.h.

130 { i = o.i; return *this; }

◆ operator==() [1/2]

template<class T>
bool QLinkedList< T >::iterator::operator== ( const iterator o) const
inline

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

Definition at line 133 of file qlinkedlist.h.

133 { return i == o.i; }

◆ operator==() [2/2]

template<class T>
bool QLinkedList< T >::iterator::operator== ( const const_iterator other) const
inline
See also
operator!=()

Definition at line 135 of file qlinkedlist.h.

136  { return i == o.i; }

Properties

◆ i

template<class T>
Node* QLinkedList< T >::iterator::i

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