Templateded iterator for iterating through a set of COO Matix elements but viewing them in transpose. More...

#include <AbstractLinAlgPack_TransSparseCOOElementViewIter.hpp>

Classes
class	ElementView
	Type for the object that is returned for the transpose sparse element. More...

Public types.
typedef ElementView< T_Iter, T_IterCat, T_Indice,T_ValRef, T_Diff >	element_view_type

typedef T_Iter	encap_iter_type

typedef TransSparseCOOElementViewIter < T_Iter, T_IterCat,T_Indice, T_ValRef, T_Diff >	iterator_type

typedef T_IterCat	iterator_category

typedef element_view_type	value_type

typedef element_view_type &	reference_type

typedef element_view_type *	pointer_type

typedef T_Diff	difference_type

typedef size_t	distance_type

Constructors.
	TransSparseCOOElementViewIter (T_Iter itr)
	Construct with the iterator of COO elements to transpose. More...

Iterator control functions.
reference_type	operator* () const

pointer_type	operator-> () const

value_type	operator[] (distance_type n) const

iterator_type &	operator++ ()

const iterator_type	operator++ (int)

iterator_type &	operator-- ()

const iterator_type	operator-- (int)

iterator_type	operator+ (distance_type n)

const iterator_type	operator+ (distance_type n) const

iterator_type &	operator+= (distance_type n)

iterator_type	operator- (distance_type n)

const iterator_type	operator- (distance_type n) const

iterator_type &	operator-= (distance_type n)

distance_type	operator- (const iterator_type &itr) const

Comparison Operators.
bool	operator< (const iterator_type &itr)

bool	operator<= (const iterator_type &itr)

bool	operator> (const iterator_type &itr)

bool	operator>= (const iterator_type &itr)

bool	operator== (const iterator_type &itr)

bool	operator!= (const iterator_type &itr)

Detailed Description

template<class T_Iter, class T_IterCat, class T_Indice, class T_ValRef, class T_Diff>
class AbstractLinAlgPack::TransSparseCOOElementViewIter< T_Iter, T_IterCat, T_Indice, T_ValRef, T_Diff >

Templateded iterator for iterating through a set of COO Matix elements but viewing them in transpose.

The iterator type T_Iter must yield a type that conforms to the SparseCOOElementTemplateInterface specification. In particular it must support itr->value(), itr->row_i(), and itr->col_i().

Any category of iterator can be used with this class. The relavant iterator traits have to be added to the template list since MS VC++ 5.0 does not support partial template specialization and therefore std::iterator_traits<> does not exist.

There is a lot of code here but for an iterator object, only the underlying iterator is stored. Thus, because of inlining accessing a COO matrix through this transposed iterator is just as efficient as assessing it through its non-transposed iterator. This is important for efficiency reasons.

The default assignment operator and copy constructor are allowed.

The template arguments are:{itemize} T_Iter The type of the iterator that is used to yield COO sparse elements T_IterCat The category of iterator (forward, random access etc.) T_Indice The type returned by itr->indice() T_ValRef The type for the value returned by value(). For example, if T_Ele is a const type then T_ValRef should be a constant reference and if it is a non-const type it should be a non-const reference.

Definition at line 80 of file AbstractLinAlgPack_TransSparseCOOElementViewIter.hpp.