We create a suitable class for iterator types here. More...

Inheritance diagram for gsl::matrix_ushort::iterator_base< container, content, reverse_t >:

Collaboration diagram for gsl::matrix_ushort::iterator_base< container, content, reverse_t >:

Public Types
typedef std::bidirectional_iterator_tag	iterator_category
	An iterator must have an iterator category. More...

typedef vector_ushort	value_type
	An iterator must have a value type. More...

typedef vector_ushort_ptr	pointer
	An iterator must have a pointer typea. More...

typedef value_type	reference
	An iterator must have a reference type. More...

Public Member Functions
reference	operator* () const
	Dereference the pointer. More...

pointer	operator-> () const
	Dereference the pointer. 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...

Protected Member Functions
void	increment ()
	Increment the iterator. More...

void	decrement ()
	Decrement the iterator. More...

	iterator_base ()
	The iterator is default constructible. More...

	iterator_base (container *v, size_t position)
	This constructor allows vector_ushort to create non-default iterators. More...

Protected Attributes
container *	v
	Store a pointer to a matrix_ushort we can iterate over: 0 if no matrix_ushort. More...

size_t	position
	Mark position of iterator within matrix_ushort. More...

Friends
class	vector_ushort

Detailed Description

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

We create a suitable class for iterator types here.

Definition at line 257 of file matrix_ushort.hpp.

Member Typedef Documentation

◆ iterator_category

template<typename container , typename content , bool reverse_t>

typedef std::bidirectional_iterator_tag gsl::matrix_ushort::iterator_base< container, content, reverse_t >::iterator_category

An iterator must have an iterator category.

Definition at line 263 of file matrix_ushort.hpp.

◆ pointer

template<typename container , typename content , bool reverse_t>

typedef vector_ushort_ptr gsl::matrix_ushort::iterator_base< container, content, reverse_t >::pointer

An iterator must have a pointer typea.

Definition at line 271 of file matrix_ushort.hpp.

◆ reference

template<typename container , typename content , bool reverse_t>

typedef value_type gsl::matrix_ushort::iterator_base< container, content, reverse_t >::reference

An iterator must have a reference type.

Definition at line 275 of file matrix_ushort.hpp.

◆ value_type

template<typename container , typename content , bool reverse_t>

typedef vector_ushort gsl::matrix_ushort::iterator_base< container, content, reverse_t >::value_type

An iterator must have a value type.

Definition at line 267 of file matrix_ushort.hpp.

Constructor & Destructor Documentation

◆ iterator_base() [1/2]

template<typename container , typename content , bool reverse_t>

gsl::matrix_ushort::iterator_base< container, content, reverse_t >::iterator_base ( )

inlineprotected

The iterator is default constructible.

Definition at line 385 of file matrix_ushort.hpp.

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

◆ iterator_base() [2/2]

template<typename container , typename content , bool reverse_t>

gsl::matrix_ushort::iterator_base< container, content, reverse_t >::iterator_base	(	container *	v,
		size_t	position
	)

inlineprotected

This constructor allows vector_ushort to create non-default iterators.

Parameters

v	The matrix_ushort that creates `this`
position	The initial postion of the iterator

Definition at line 391 of file matrix_ushort.hpp.

Member Function Documentation

◆ decrement()

template<typename container , typename content , bool reverse_t>

void gsl::matrix_ushort::iterator_base< container, content, reverse_t >::decrement ( )

inlineprotected

Decrement the iterator.

Returns: 0 for success, anything else for failure

Definition at line 369 of file matrix_ushort.hpp.

References gsl::exception::GSL_EFAILED, gsl::matrix_ushort::iterator_base< container, content, reverse_t >::position, gsl::matrix_ushort::size1(), and gsl::matrix_ushort::iterator_base< container, content, reverse_t >::v.

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

◆ increment()

template<typename container , typename content , bool reverse_t>

void gsl::matrix_ushort::iterator_base< container, content, reverse_t >::increment ( )

inlineprotected

Increment the iterator.

Returns: 0 for success, anything else for failure

Definition at line 352 of file matrix_ushort.hpp.

References gsl::exception::GSL_EFAILED, gsl::matrix_ushort::iterator_base< container, content, reverse_t >::position, gsl::matrix_ushort::size1(), and gsl::matrix_ushort::iterator_base< container, content, reverse_t >::v.

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

◆ operator!=()

template<typename container , typename content , bool reverse_t>

bool gsl::matrix_ushort::iterator_base< container, content, reverse_t >::operator!= ( iterator_base< container, content, reverse_t > const & i ) const

inline

The != operator.

Parameters

i	The iterator being compared

Returns: true or false according as i != *this

Definition at line 344 of file matrix_ushort.hpp.

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

◆ operator*()

template<typename container , typename content , bool reverse_t>

reference gsl::matrix_ushort::iterator_base< container, content, reverse_t >::operator* ( ) const

inline

Dereference the pointer.

Returns: a reference to content

Definition at line 282 of file matrix_ushort.hpp.

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

◆ operator->()

template<typename container , typename content , bool reverse_t>

pointer gsl::matrix_ushort::iterator_base< container, content, reverse_t >::operator-> ( ) const

inline

Dereference the pointer.

Returns: a pointer to content

Definition at line 306 of file matrix_ushort.hpp.

References gsl::exception::GSL_EFAILED, gsl::matrix_ushort::iterator_base< container, content, reverse_t >::position, gsl::matrix_ushort::ptr(), and gsl::matrix_ushort::iterator_base< container, content, reverse_t >::v.

◆ operator==()

template<typename container , typename content , bool reverse_t>

bool gsl::matrix_ushort::iterator_base< container, content, reverse_t >::operator== ( iterator_base< container, content, reverse_t > const & i ) const

inline

The == operator.

Parameters

i	The iterator being compared

Returns: true or false according as i != *this

Definition at line 336 of file matrix_ushort.hpp.

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

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

Friends And Related Function Documentation

◆ vector_ushort

template<typename container , typename content , bool reverse_t>

friend class vector_ushort

friend

Definition at line 258 of file matrix_ushort.hpp.

Member Data Documentation

◆ position

template<typename container , typename content , bool reverse_t>

size_t gsl::matrix_ushort::iterator_base< container, content, reverse_t >::position

protected

Mark position of iterator within matrix_ushort.

Definition at line 400 of file matrix_ushort.hpp.

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

◆ v

template<typename container , typename content , bool reverse_t>

container* gsl::matrix_ushort::iterator_base< container, content, reverse_t >::v

protected

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

Definition at line 396 of file matrix_ushort.hpp.

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

matrix_ushort.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ iterator_base() [1/2]

◆ iterator_base() [2/2]

Member Function Documentation

◆ decrement()

◆ increment()

◆ operator!=()

◆ operator*()

◆ operator->()

◆ operator==()

Friends And Related Function Documentation

◆ vector_ushort

Member Data Documentation

◆ position

◆ v