ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::block_ushort::const_iterator_t< reverse > Class Template Reference

A class template for the const iterators. More...

Inheritance diagram for gsl::block_ushort::const_iterator_t< reverse >:
Inheritance graph
Collaboration diagram for gsl::block_ushort::const_iterator_t< reverse >:
Collaboration graph

Public Types

typedef iterator_base< block_ushortconst, unsignedshort, reverse >::difference_type difference_type
 Difference type. More...
 
- Public Types inherited from gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >
typedef std::random_access_iterator_tag iterator_category
 An iterator must have an iterator category. More...
 
typedef unsigned short value_type
 An iterator must have a value type. More...
 
typedef value_typepointer
 An iterator must have a pointer typea. More...
 
typedef value_typereference
 An iterator must have a reference type. More...
 
typedef ptrdiff_t difference_type
 An iterator must have a difference_type. More...
 

Public Member Functions

const_iterator_t< reverse > & operator= (const_iterator_t< reverse > const &i)
 We can assign one output iterator from another. More...
 
const_iterator_t< reverse > & operator++ ()
 The prefix ++ operator. More...
 
const_iterator_t< reverse > operator++ (int)
 The postfix ++ operator. More...
 
const_iterator_t< reverse > & operator-- ()
 The prefix – operator. More...
 
const_iterator_t< reverse > operator-- (int)
 The postfix – operator. More...
 
const_iterator_t< reverse > & operator+= (difference_type const n)
 The += operator. More...
 
const_iterator_t< reverse > & operator-= (difference_type const n)
 The -= operator. More...
 
const_iterator_t< reverse > operator+ (difference_type const n) const
 The + operator. More...
 
const_iterator_t< reverse > operator- (difference_type const n) const
 The - operator: subtract distance from iterator. More...
 
difference_type operator- (const_iterator_t< reverse > const &i) const
 The - operator: find distance between two iterators. More...
 
difference_type operator- (iterator_t< reverse > const &i) const
 The - operator: find distance between two iterators. More...
 
 const_iterator_t ()
 The default constructor. More...
 
 const_iterator_t (iterator_t< reverse > const &i)
 A copy constructor. More...
 
bool operator== (iterator_t< reverse > const &i) const
 Comparison with non-const iterator. More...
 
bool operator!= (iterator_t< reverse > const &i) const
 Comparison with non-const iterator. More...
 
bool operator< (iterator_t< reverse > const &i) const
 Comparison with non-const iterator. More...
 
bool operator== (const_iterator_t< reverse > const &i) const
 Comparison with const iterator. More...
 
bool operator!= (const_iterator_t< reverse > const &i) const
 Comparison with const iterator. More...
 
bool operator< (const_iterator_t< reverse > const &i) const
 Comparison with const iterator. More...
 
- Public Member Functions inherited from gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >
reference operator* () const
 Dereference the pointer. More...
 
pointer operator-> () const
 Dereference the pointer. More...
 
reference operator[] (difference_type const n) const
 Get element at i + n by reference ([] operator). More...
 
difference_type operator- (iterator_base< block_ushort const, unsigned short, reverse > const &i) const
 The - operator: find distance between two iterators. More...
 
bool operator== (iterator_base< block_ushort const, unsigned short, reverse > const &i) const
 The == operator. More...
 
bool operator!= (iterator_base< block_ushort const, unsigned short, reverse > const &i) const
 The != operator. More...
 
bool operator< (iterator_base< block_ushort const, unsigned short, reverse > const &i) const
 The < operator is used to compare iterators. More...
 

Protected Member Functions

 const_iterator_t (block_ushort const *v, difference_type position)
 This constructor allows block_ushort to create non-default iterators. More...
 
- Protected Member Functions inherited from gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >
void increment ()
 Increment the iterator. More...
 
void decrement ()
 Decrement the iterator. More...
 
void shift (difference_type const n)
 Shift iterator n places. More...
 
 iterator_base ()
 The iterator is default constructible. More...
 
 iterator_base (block_ushort const *v, difference_type position)
 This constructor allows block_ushort to create non-default iterators. More...
 

Friends

class block_ushort
 

Additional Inherited Members

- Protected Attributes inherited from gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >
block_ushort const * v
 Store a pointer to a block_ushort we can iterate over: 0 if no block_ushort. More...
 
difference_type position
 Mark position of iterator within block_ushort. More...
 

Detailed Description

template<bool reverse>
class gsl::block_ushort::const_iterator_t< reverse >

A class template for the const iterators.

Definition at line 752 of file block_ushort.hpp.

Member Typedef Documentation

◆ difference_type

template<bool reverse>
typedef iterator_base<block_ushortconst,unsignedshort,reverse>::difference_type gsl::block_ushort::const_iterator_t< reverse >::difference_type

Difference type.

Definition at line 810 of file block_ushort.hpp.

Constructor & Destructor Documentation

◆ const_iterator_t() [1/3]

template<bool reverse>
gsl::block_ushort::const_iterator_t< reverse >::const_iterator_t ( )
inline

The default constructor.

Definition at line 888 of file block_ushort.hpp.

◆ const_iterator_t() [2/3]

template<bool reverse>
gsl::block_ushort::const_iterator_t< reverse >::const_iterator_t ( iterator_t< reverse > const &  i)
inline

A copy constructor.

Parameters
iThe non-const iterator to copy

Definition at line 893 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::position, and gsl::block_ushort::iterator_base< container, content, reverse >::v.

◆ const_iterator_t() [3/3]

template<bool reverse>
gsl::block_ushort::const_iterator_t< reverse >::const_iterator_t ( block_ushort const *  v,
difference_type  position 
)
inlineprotected

This constructor allows block_ushort to create non-default iterators.

Parameters
vThe block_ushort that creates this
positionThe initial postion of the iterator

Definition at line 975 of file block_ushort.hpp.

Member Function Documentation

◆ operator!=() [1/2]

template<bool reverse>
bool gsl::block_ushort::const_iterator_t< reverse >::operator!= ( const_iterator_t< reverse > const &  i) const
inline

Comparison with const iterator.

Parameters
ianother iterator
Returns
false or true according as this points to same element as i

Definition at line 945 of file block_ushort.hpp.

References gsl::block_ushort::const_iterator_t< reverse >::operator==().

◆ operator!=() [2/2]

template<bool reverse>
bool gsl::block_ushort::const_iterator_t< reverse >::operator!= ( iterator_t< reverse > const &  i) const
inline

Comparison with non-const iterator.

Parameters
ianother iterator
Returns
false or true according as this points to same element as i

Definition at line 910 of file block_ushort.hpp.

References gsl::block_ushort::const_iterator_t< reverse >::operator==().

◆ operator+()

template<bool reverse>
const_iterator_t< reverse > gsl::block_ushort::const_iterator_t< reverse >::operator+ ( difference_type const  n) const
inline

The + operator.

Parameters
nA difference_type value to be added
Returns
A new iterator
See also
ccgsl::operator+();

Definition at line 838 of file block_ushort.hpp.

References gsl::rstat::n().

◆ operator++() [1/2]

template<bool reverse>
const_iterator_t< reverse > & gsl::block_ushort::const_iterator_t< reverse >::operator++ ( )
inline

The prefix ++ operator.

Returns
this

Definition at line 772 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::increment().

◆ operator++() [2/2]

template<bool reverse>
const_iterator_t< reverse > gsl::block_ushort::const_iterator_t< reverse >::operator++ ( int  )
inline

The postfix ++ operator.

Returns
this

Definition at line 780 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::increment().

◆ operator+=()

template<bool reverse>
const_iterator_t< reverse > & gsl::block_ushort::const_iterator_t< reverse >::operator+= ( difference_type const  n)
inline

The += operator.

Parameters
nA difference_type value to be added to position of iterator
Returns
this

Definition at line 817 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >::shift().

◆ operator-() [1/3]

template<bool reverse>
difference_type gsl::block_ushort::const_iterator_t< reverse >::operator- ( const_iterator_t< reverse > const &  i) const
inline

The - operator: find distance between two iterators.

Parameters
iA second iterator
Returns
(signed) distance between this and i

Definition at line 860 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::operator-().

◆ operator-() [2/3]

template<bool reverse>
const_iterator_t< reverse > gsl::block_ushort::const_iterator_t< reverse >::operator- ( difference_type const  n) const
inline

The - operator: subtract distance from iterator.

Parameters
nA difference_type value to be subtracted
Returns
A new iterator
See also
ccgsl::operator-();

Definition at line 850 of file block_ushort.hpp.

References gsl::rstat::n().

◆ operator-() [3/3]

◆ operator--() [1/2]

template<bool reverse>
const_iterator_t< reverse > & gsl::block_ushort::const_iterator_t< reverse >::operator-- ( )
inline

The prefix – operator.

Returns
this

Definition at line 792 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::decrement().

◆ operator--() [2/2]

template<bool reverse>
const_iterator_t< reverse > gsl::block_ushort::const_iterator_t< reverse >::operator-- ( int  )
inline

The postfix – operator.

Returns
this

Definition at line 800 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::decrement().

◆ operator-=()

template<bool reverse>
const_iterator_t< reverse > & gsl::block_ushort::const_iterator_t< reverse >::operator-= ( difference_type const  n)
inline

The -= operator.

Parameters
nA difference_type value to be subtracted from position of iterator
Returns
this

Definition at line 827 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< block_ushort const, unsigned short, reverse >::shift().

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator=()

template<bool reverse>
const_iterator_t< reverse > & gsl::block_ushort::const_iterator_t< reverse >::operator= ( const_iterator_t< reverse > const &  i)
inline

We can assign one output iterator from another.

Parameters
iThe iterator to copy

Definition at line 761 of file block_ushort.hpp.

References gsl::block_ushort::iterator_base< container, content, reverse >::position, and gsl::block_ushort::iterator_base< container, content, reverse >::v.

◆ operator==() [1/2]

template<bool reverse>
bool gsl::block_ushort::const_iterator_t< reverse >::operator== ( const_iterator_t< reverse > const &  i) const
inline

◆ operator==() [2/2]

template<bool reverse>
bool gsl::block_ushort::const_iterator_t< reverse >::operator== ( iterator_t< reverse > const &  i) const
inline

Friends And Related Function Documentation

◆ block_ushort

template<bool reverse>
friend class block_ushort
friend

Definition at line 969 of file block_ushort.hpp.


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