FBB::Iterator - Iterator returning plain values when dereferenced
FBB::ReverseIterator - reverse_iterator for FBB::Iterator
SYNOPSIS
#include <bobcat/iterator>
DESCRIPTION
The FBB::Iterator<Type> class template implements a bidirectional iterator
for plain data types. Dereferencing FBB::Iterator objects returns values
of type Type, e.g., char or int. This iterator comes in handy in
case you need to initialize an objects with a range of values, which are of
some basic type (see also the EXAMPLE section).
FBB::ReverseIterator implements a reverse iterator for FBB::Iterator.
NAMESPACE
FBB
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace FBB.
explicit Iterator(Tye const &value):
This constructor initializes the Iterator object with an initial
Type value. When dereferencing this iterator, value is
returned.
The default implementations of the Iterator<Type>'s default, copy, and
move constructors are available.
Constructors for ReverseIterator<Type>:
explicit ReverseIterator(Type const &value):
This constructor initializes the ReverseIterator object with an
initial Type value. When dereferencing this iterator immediately
following its construction, the decremented value is returned
(without modifying the internally stored Type value);
explicit ReverseIterator(Iterator<Type> const &iter):
This constructor initializes the ReverseIterator object with an
initial Iterator<Type> object. When dereferencing this iterator
immediately following its construction, the decremented Iterator's
value is returned (without modifying the Type
value that is stored inside the Iterator).
The default implementations of the ReverseIterator<Type>'s default, copy,
and move constructors are available.
MEMBER FUNCTIONS
For template parameter type Type all members of
std::iterator<std:::reverse_iterator_tag, Type> are available, as
FBB::Iterator and FBB::ReverseIterator inherit from this class.
Iterator<Type> &operator++():
The (prefix) increment operator increments the iterator's value and
returns a reference to itself;
Iterator<Type> &operator++(int):
The (postfix) increment operator increments the iterator's value and
returns a copy of itself, initialized with the iterator's value before
it was incremented;
Iterator<Type> &operator--():
The (prefix) decrement operator decrements the iterator's value and
returns a reference to itself;
Iterator<Type> &operator--(int):
The (postfix) decrement operator decrements the iterator's value and
returns a copy of itself, initialized with the iterator's value before
it was decremented;
bool operator==(Iterator<Type> const &rhs) const:
This operator returns true if the value of the current Iterator
object is equal to the value of the rhsIterator object;
bool operator!=(Iterator<Type> const &rhs) const:
This operator returns true if the value of the current Iterator
object is not equal to the value of the rhsIterator object;
Type &operator*():
The derefence operator returns a reference to the Iterator's value.
Type const &operator*() const:
This derefence operator returns a reference to the Iterator's
immutable value.
STATIC MEMBER FUNCTIONS
Static members of Iterator<Type>:
Iterator<Type> last(Type value):
An Iterator<Type> object is returned initialized with ++value,
so it can be conveniently be used to create an inclusive iterator
range (see also section EXAMPLE);
Iterator<Type> max():
An Iterator<Type> object is returned initialized with the value
returned by std::numeric_limits<Type>::max();
Iterator<Type> min():
An Iterator<Type> object is returned initialized with the value
returned by std::numeric_limits<Type>::min()
Static member of ReverseIterator<Type>:
ReverseIterator<Type> last(Type const &value):
A ReverseIterator<Type> object is returned initialized with
Iterator<Type>::last(value), so it can be conveniently be used to
create an inclusive reverse iterator range (see also section
EXAMPLE);