ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
gsl::vector_complex_float::iterator_base< container, content, reverse_t > Class Template Reference

The container must have iterator types. More...

Inheritance diagram for gsl::vector_complex_float::iterator_base< container, content, reverse_t >:
Inheritance graph
Collaboration diagram for gsl::vector_complex_float::iterator_base< container, content, reverse_t >:
Collaboration graph

Public Types

typedef complex_float value_type
 An iterator must have a value_type. More...
 
typedef complex_float_ref reference
 An iterator must have a reference type. More...
 
typedef complex_float_ptr pointer
 An iterator must have a pointer type. More...
 
typedef std::random_access_iterator_tag iterator_category
 An iterator must have a pointer type. More...
 
typedef ptrdiff_t difference_type
 An iterator must have a difference_type. More...
 

Public Member Functions

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< container, content, reverse_t > const &i) const
 The - operator: find distance between two iterators. More...
 
bool operator== (iterator_base< container, content, reverse_t > const &i) const
 The == operator. More...
 
bool operator!= (iterator_base< container, content, reverse_t > const &i) const
 The != operator. More...
 
bool operator< (iterator_base< container, content, reverse_t > const &i) const
 The < operator is used to compare iterators. More...
 

Protected Member Functions

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 (container *v, difference_type position)
 This constructor allows vector_complex_float to create non-default iterators. More...
 

Protected Attributes

container * v
 Store a pointer to a vector_complex_float we can iterate over: 0 if no vector_complex_float. More...
 
difference_type position
 Mark position of iterator within vector_complex_float. More...
 

Friends

class vector_complex_float
 

Detailed Description

template<typename container, typename content, bool reverse_t>
class gsl::vector_complex_float::iterator_base< container, content, reverse_t >

The container must have iterator types.

We create a suitable class here.

Definition at line 376 of file vector_complex_float.hpp.

Member Typedef Documentation

◆ difference_type

template<typename container , typename content , bool reverse_t>
typedef ptrdiff_t gsl::vector_complex_float::iterator_base< container, content, reverse_t >::difference_type

An iterator must have a difference_type.

Definition at line 399 of file vector_complex_float.hpp.

◆ iterator_category

template<typename container , typename content , bool reverse_t>
typedef std::random_access_iterator_tag gsl::vector_complex_float::iterator_base< container, content, reverse_t >::iterator_category

An iterator must have a pointer type.

Definition at line 394 of file vector_complex_float.hpp.

◆ pointer

template<typename container , typename content , bool reverse_t>
typedef complex_float_ptr gsl::vector_complex_float::iterator_base< container, content, reverse_t >::pointer

An iterator must have a pointer type.

Definition at line 390 of file vector_complex_float.hpp.

◆ reference

template<typename container , typename content , bool reverse_t>
typedef complex_float_ref gsl::vector_complex_float::iterator_base< container, content, reverse_t >::reference

An iterator must have a reference type.

Definition at line 386 of file vector_complex_float.hpp.

◆ value_type

template<typename container , typename content , bool reverse_t>
typedef complex_float gsl::vector_complex_float::iterator_base< container, content, reverse_t >::value_type

An iterator must have a value_type.

Definition at line 382 of file vector_complex_float.hpp.

Constructor & Destructor Documentation

◆ iterator_base() [1/2]

template<typename container , typename content , bool reverse_t>
gsl::vector_complex_float::iterator_base< container, content, reverse_t >::iterator_base ( )
inlineprotected

The iterator is default constructible.

Definition at line 596 of file vector_complex_float.hpp.

References gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

◆ iterator_base() [2/2]

template<typename container , typename content , bool reverse_t>
gsl::vector_complex_float::iterator_base< container, content, reverse_t >::iterator_base ( container *  v,
difference_type  position 
)
inlineprotected

This constructor allows vector_complex_float to create non-default iterators.

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

Definition at line 602 of file vector_complex_float.hpp.

Member Function Documentation

◆ decrement()

template<typename container , typename content , bool reverse_t>
void gsl::vector_complex_float::iterator_base< container, content, reverse_t >::decrement ( )
inlineprotected

Decrement the iterator.

Returns
0 for success, anything else for failure

Definition at line 565 of file vector_complex_float.hpp.

References gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

Referenced by gsl::vector_complex_float::iterator_t< reverse_t >::operator--(), and gsl::vector_complex_float::const_iterator_t< reverse_t >::operator--().

◆ increment()

template<typename container , typename content , bool reverse_t>
void gsl::vector_complex_float::iterator_base< container, content, reverse_t >::increment ( )
inlineprotected

Increment the iterator.

Returns
0 for success, anything else for failure

Definition at line 548 of file vector_complex_float.hpp.

References gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

Referenced by gsl::vector_complex_float::iterator_t< reverse_t >::operator++(), and gsl::vector_complex_float::const_iterator_t< reverse_t >::operator++().

◆ operator!=()

template<typename container , typename content , bool reverse_t>
bool gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator!= ( iterator_base< container, content, reverse_t > const &  i) const
inline

The != operator.

Parameters
iThe iterator being compared
Returns
true or false according as i != *this

Definition at line 519 of file vector_complex_float.hpp.

References gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator==().

◆ operator*()

template<typename container , typename content , bool reverse_t>
reference gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator* ( ) const
inline

Dereference the pointer.

Returns
a reference to content

Definition at line 406 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

◆ operator-()

template<typename container , typename content , bool reverse_t>
difference_type gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator- ( iterator_base< container, content, reverse_t > 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 487 of file vector_complex_float.hpp.

References gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

Referenced by gsl::vector_complex_float::const_iterator_t< reverse_t >::operator-(), and gsl::vector_complex_float::iterator_t< reverse_t >::operator-().

◆ operator->()

template<typename container , typename content , bool reverse_t>
pointer gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator-> ( ) const
inline

Dereference the pointer.

Returns
a pointer to content

Definition at line 432 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

◆ operator<()

template<typename container , typename content , bool reverse_t>
bool gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator< ( iterator_base< container, content, reverse_t > const &  i) const
inline

The < operator is used to compare iterators.

This only makes sense if the iterators iterate over the same vector_complex_float and the function calls a GSL error handler and returns false if they do not.

Parameters
iThe iterator being compared
Returns
true or false according as i < j

Definition at line 529 of file vector_complex_float.hpp.

References gsl::exception::GSL_EFAILED, gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

◆ operator==()

template<typename container , typename content , bool reverse_t>
bool gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator== ( iterator_base< container, content, reverse_t > const &  i) const
inline

The == operator.

Parameters
iThe iterator being compared
Returns
true or false according as i != *this

Definition at line 511 of file vector_complex_float.hpp.

References gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

Referenced by gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator!=().

◆ operator[]()

template<typename container , typename content , bool reverse_t>
reference gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator[] ( difference_type const  n) const
inline

Get element at i + n by reference ([] operator).

Parameters
nThe offset from i
Returns
a reference to content

Definition at line 459 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::exception::GSL_EFAILED, gsl::rstat::n(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

◆ shift()

template<typename container , typename content , bool reverse_t>
void gsl::vector_complex_float::iterator_base< container, content, reverse_t >::shift ( difference_type const  n)
inlineprotected

Shift iterator n places.

Parameters
nA difference_type value to be added to position of iterator

Definition at line 582 of file vector_complex_float.hpp.

References gsl::exception::GSL_EFAILED, gsl::rstat::n(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position, and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v.

Friends And Related Function Documentation

◆ vector_complex_float

template<typename container , typename content , bool reverse_t>
friend class vector_complex_float
friend

Definition at line 377 of file vector_complex_float.hpp.

Member Data Documentation

◆ position

template<typename container , typename content , bool reverse_t>
difference_type gsl::vector_complex_float::iterator_base< container, content, reverse_t >::position
protected

Mark position of iterator within vector_complex_float.

Definition at line 611 of file vector_complex_float.hpp.

Referenced by gsl::vector_complex_float::const_iterator_t< reverse_t >::const_iterator_t(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::decrement(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::increment(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator*(), gsl::vector_complex_float::iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator-(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator->(), gsl::vector_complex_float::iterator_t< reverse_t >::operator<(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator<(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator<(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator=(), gsl::vector_complex_float::iterator_t< reverse_t >::operator=(), gsl::vector_complex_float::iterator_t< reverse_t >::operator==(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator==(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator==(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator[](), and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::shift().

◆ v

template<typename container , typename content , bool reverse_t>
container* gsl::vector_complex_float::iterator_base< container, content, reverse_t >::v
protected

Store a pointer to a vector_complex_float we can iterate over: 0 if no vector_complex_float.

Definition at line 607 of file vector_complex_float.hpp.

Referenced by gsl::vector_complex_float::const_iterator_t< reverse_t >::const_iterator_t(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::decrement(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::increment(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::iterator_base(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator*(), gsl::vector_complex_float::iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator-(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator->(), gsl::vector_complex_float::iterator_t< reverse_t >::operator<(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator<(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator<(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator=(), gsl::vector_complex_float::iterator_t< reverse_t >::operator=(), gsl::vector_complex_float::iterator_t< reverse_t >::operator==(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator==(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator==(), gsl::vector_complex_float::iterator_base< container, content, reverse_t >::operator[](), and gsl::vector_complex_float::iterator_base< container, content, reverse_t >::shift().

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