TString< TChar >::TRandomAccessIterator< TCharConstOrMutable > Class Template Reference

Description:

template<typename TChar>
template<typename TCharConstOrMutable>
class alib::strings::TString< TChar >::TRandomAccessIterator< TCharConstOrMutable >

Implementation of std::iterator_traits for class TString and its descendents. Base class String exposes ConstIterator which uses const TChar* and const TChar& for template types TPointer and TReference. Descendant classes may expose a mutable version (e.g., AString).

As the name of the class indicates, this iterator satisfies the C++ standard library concept RandomAccessIterator .

Definition at line 2109 of file string.hpp.

#include <string.hpp>

Public Type Index:
using	difference_type = integer
	Implementation of std::iterator_traits.
using	iterator_category = std::random_access_iterator_tag
	Implementation of std::iterator_traits.
using	pointer = TCharConstOrMutable*
	Implementation of std::iterator_traits.
using	reference = TCharConstOrMutable&
	Implementation of std::iterator_traits.
using	value_type = TCharConstOrMutable
	Implementation of std::iterator_traits.

Public Method Index:
	TRandomAccessIterator (TCharConstOrMutable *start=nullptr)
bool	operator!= (TRandomAccessIterator other) const
TCharConstOrMutable &	operator* ()
TCharConstOrMutable &	operator* () const
TRandomAccessIterator	operator+ (integer n) const
ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE TRandomAccessIterator &	operator++ ()
TRandomAccessIterator	operator++ (int)
TRandomAccessIterator &	operator+= (integer n)
TRandomAccessIterator	operator- (integer n) const
integer	operator- (TRandomAccessIterator other) const
TRandomAccessIterator &	operator-- ()
TRandomAccessIterator	operator-- (int)
TRandomAccessIterator &	operator-= (integer n)
bool	operator< (TRandomAccessIterator other) const
bool	operator<= (TRandomAccessIterator other) const
bool	operator== (TRandomAccessIterator other) const
bool	operator> (TRandomAccessIterator other) const
bool	operator>= (TRandomAccessIterator other) const
TCharConstOrMutable &	operator[] (integer n) const

Protected Field Index:
TCharConstOrMutable *	p
	The pointer into the buffer is all we store.

Type Definition Details:

difference_type

template<typename TChar >

template<typename TCharConstOrMutable >

using difference_type = integer

Implementation of std::iterator_traits.

Definition at line 2114 of file string.hpp.

iterator_category

template<typename TChar >

template<typename TCharConstOrMutable >

using iterator_category = std::random_access_iterator_tag

Implementation of std::iterator_traits.

Definition at line 2112 of file string.hpp.

pointer

template<typename TChar >

template<typename TCharConstOrMutable >

using pointer = TCharConstOrMutable*

Implementation of std::iterator_traits.

Definition at line 2115 of file string.hpp.

reference

template<typename TChar >

template<typename TCharConstOrMutable >

using reference = TCharConstOrMutable&

Implementation of std::iterator_traits.

Definition at line 2116 of file string.hpp.

value_type

template<typename TChar >

template<typename TCharConstOrMutable >

using value_type = TCharConstOrMutable

Implementation of std::iterator_traits.

Definition at line 2113 of file string.hpp.

Field Details:

p

template<typename TChar >

template<typename TCharConstOrMutable >

TCharConstOrMutable* p

protected

The pointer into the buffer is all we store.

Definition at line 2121 of file string.hpp.

Constructor(s) / Destructor Details:

TRandomAccessIterator()

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator ( TCharConstOrMutable * start = nullptr )

inlineexplicit

Constructor.

Parameters

start

Pointer to the initial character.

Definition at line 2125 of file string.hpp.

Method Details:

operator!=()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator!= ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Comparison operator.

Parameters

other

The iterator to compare ourselves to.

Returns

true if this and given iterator are not equal, false otherwise.

Definition at line 2158 of file string.hpp.

operator*() [1/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TCharConstOrMutable & operator* ( )

inline

Retrieves the character that this iterator references.

Returns

The character value.

Definition at line 2172 of file string.hpp.

operator*() [2/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TCharConstOrMutable & operator* ( ) const

inline

Retrieves the character that this iterator references.

Returns

The character value.

Definition at line 2165 of file string.hpp.

operator+()

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator operator+ ( integer n ) const

inline

Addition.

Parameters

n	The value to subtract.

Returns

The resulting iterator value.

Definition at line 2220 of file string.hpp.

Here is the call graph for this function:

operator++() [1/2]

template<typename TChar >

template<typename TCharConstOrMutable >

ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE TRandomAccessIterator & operator++ ( )

inline

Prefix increment operator.

Returns

A reference to this object.

Definition at line 2133 of file string.hpp.

operator++() [2/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator operator++ ( int )

inline

Postfix increment operator.

Returns

An iterator value that is not increased, yet.

Definition at line 2141 of file string.hpp.

Here is the call graph for this function:

operator+=()

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator & operator+= ( integer n )

inline

Addition assignment.

Parameters

n	The value to subtract.

Returns

A reference to this iterator.

Definition at line 2202 of file string.hpp.

operator-() [1/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator operator- ( integer n ) const

inline

Subtraction.

Parameters

n	The value to subtract.

Returns

The resulting iterator value.

Definition at line 2228 of file string.hpp.

Here is the call graph for this function:

operator-() [2/2]

template<typename TChar >

template<typename TCharConstOrMutable >

integer operator- ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Difference (distance) from this iterator to the given one.

Parameters

other

The iterator to subtract

Returns

The difference between (distance of) this and the given iterator.

Definition at line 2236 of file string.hpp.

operator--() [1/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator & operator-- ( )

inline

Prefix decrement operator.

Returns

A reference to this object.

Definition at line 2182 of file string.hpp.

operator--() [2/2]

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator operator-- ( int )

inline

Postfix decrement operator.

Returns

The iterator value prior the decrement operation.

Definition at line 2191 of file string.hpp.

Here is the call graph for this function:

operator-=()

template<typename TChar >

template<typename TCharConstOrMutable >

TRandomAccessIterator & operator-= ( integer n )

inline

Subtraction assignment.

Parameters

n	The value to subtract.

Returns

A reference to this iterator.

Definition at line 2211 of file string.hpp.

operator<()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator< ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Compares this iterator with the given one.

Parameters

other

The iterator to compare

Returns

true if this iterator is smaller than other, false otherwise.

Definition at line 2256 of file string.hpp.

operator<=()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator<= ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Compares this iterator with the given one.

Parameters

other

The iterator to compare

Returns

true if this iterator is smaller than or equal to other, false otherwise.

Definition at line 2265 of file string.hpp.

operator==()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator== ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Comparison operator.

Parameters

other

The iterator to compare ourselves to.

Returns

true if this and the given iterator are pointing to the same character in the same array, false otherwise.

Definition at line 2150 of file string.hpp.

operator>()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator> ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Compares this iterator with the given one.

Parameters

other

The iterator to compare

Returns

true if this iterator is greater than other, false otherwise.

Definition at line 2274 of file string.hpp.

operator>=()

template<typename TChar >

template<typename TCharConstOrMutable >

bool operator>= ( TRandomAccessIterator< TCharConstOrMutable > other ) const

inline

Compares this iterator with the given one.

Parameters

other

The iterator to compare

Returns

true if this iterator is greater than or equal to other, false otherwise.

Definition at line 2283 of file string.hpp.

operator[]()

template<typename TChar >

template<typename TCharConstOrMutable >

TCharConstOrMutable & operator[] ( integer n ) const

inline

Subscript operator.

Parameters

n	The distance to add.

Returns

Reference to the character referenced by this iterator plus the distance given.

Definition at line 2245 of file string.hpp.

---

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

• string.hpp