Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type > Class Template Reference

Bi-directional iterator for traversing a sparse array. More...

#include <Stokhos_SparseArray.hpp>

Inherits std::iterator< std::bidirectional_iterator_tag, std::iterator_traits< index_iterator_type >::value_type, std::iterator_traits< index_iterator_type >::difference_type, std::iterator_traits< index_iterator_type >::pointer, std::iterator_traits< index_iterator_type >::reference >.

Public Types

typedef std::iterator< std::bidirectional_iterator_tag, typename std::iterator_traits< index_iterator_type >::value_type, typename std::iterator_traits< index_iterator_type >::difference_type, typename std::iterator_traits< index_iterator_type >::pointer, typename std::iterator_traits< index_iterator_type >::referencebase_type
 
typedef base_type::iterator_category iterator_category
 
typedef base_type::value_type value_type
 
typedef base_type::difference_type difference_type
 
typedef base_type::reference reference
 
typedef base_type::pointer pointer
 
typedef std::iterator_traits< value_iterator_type >::reference value_reference
 

Public Member Functions

 SparseArrayIterator ()
 Default constructor.
 
 SparseArrayIterator (index_iterator_type index_it, value_iterator_type value_it)
 Constructor.
 
bool operator== (const SparseArrayIterator &it) const
 == operator
 
bool operator!= (const SparseArrayIterator &it) const
 != operator
 
reference operator* () const
 
pointer operator-> () const
 -> operator
 
SparseArrayIteratoroperator++ ()
 Prefix ++.
 
SparseArrayIterator operator++ (int)
 Postfix ++.
 
SparseArrayIteratoroperator-- ()
 Prefix –.
 
SparseArrayIterator operator-- (int)
 Postfix –.
 
bool operator< (const SparseArrayIterator &b) const
 Return true of *this < b.
 
value_reference value () const
 Return value associated with iterator.
 

Protected Attributes

index_iterator_type index_iterator
 Index iterator.
 
value_iterator_type value_iterator
 Value iterator.
 

Detailed Description

template<typename index_iterator_type, typename value_iterator_type>
class Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >

Bi-directional iterator for traversing a sparse array.

The "value" of the iterator is the index, which is what you get from dereferencing the iterator (* or ->). There is also a method called value() that gives you the value of the sparse array pointed at by the iterator.

This could easily be a random access iterator. I just haven't implemented those methods.

Definition at line 131 of file Stokhos_SparseArray.hpp.

Member Typedef Documentation

◆ base_type

template<typename index_iterator_type , typename value_iterator_type >
typedef std::iterator< std::bidirectional_iterator_tag, typename std::iterator_traits<index_iterator_type>::value_type, typename std::iterator_traits<index_iterator_type>::difference_type, typename std::iterator_traits<index_iterator_type>::pointer, typename std::iterator_traits<index_iterator_type>::reference > Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::base_type

Definition at line 145 of file Stokhos_SparseArray.hpp.

◆ iterator_category

template<typename index_iterator_type , typename value_iterator_type >
typedef base_type::iterator_category Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::iterator_category

Definition at line 146 of file Stokhos_SparseArray.hpp.

◆ value_type

template<typename index_iterator_type , typename value_iterator_type >
typedef base_type::value_type Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::value_type

Definition at line 147 of file Stokhos_SparseArray.hpp.

◆ difference_type

template<typename index_iterator_type , typename value_iterator_type >
typedef base_type::difference_type Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::difference_type

Definition at line 148 of file Stokhos_SparseArray.hpp.

◆ reference

template<typename index_iterator_type , typename value_iterator_type >
typedef base_type::reference Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::reference

Definition at line 149 of file Stokhos_SparseArray.hpp.

◆ pointer

template<typename index_iterator_type , typename value_iterator_type >
typedef base_type::pointer Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::pointer

Definition at line 150 of file Stokhos_SparseArray.hpp.

◆ value_reference

template<typename index_iterator_type , typename value_iterator_type >
typedef std::iterator_traits<value_iterator_type>::reference Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::value_reference

Definition at line 151 of file Stokhos_SparseArray.hpp.

Constructor & Destructor Documentation

◆ SparseArrayIterator() [1/2]

template<typename index_iterator_type , typename value_iterator_type >
Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::SparseArrayIterator ( )
inline

Default constructor.

Definition at line 154 of file Stokhos_SparseArray.hpp.

◆ SparseArrayIterator() [2/2]

template<typename index_iterator_type , typename value_iterator_type >
Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::SparseArrayIterator ( index_iterator_type  index_it,
value_iterator_type  value_it 
)
inline

Constructor.

Definition at line 157 of file Stokhos_SparseArray.hpp.

Member Function Documentation

◆ operator==()

template<typename index_iterator_type , typename value_iterator_type >
bool Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator== ( const SparseArrayIterator< index_iterator_type, value_iterator_type > &  it) const
inline

== operator

Definition at line 162 of file Stokhos_SparseArray.hpp.

◆ operator!=()

template<typename index_iterator_type , typename value_iterator_type >
bool Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator!= ( const SparseArrayIterator< index_iterator_type, value_iterator_type > &  it) const
inline

!= operator

Definition at line 168 of file Stokhos_SparseArray.hpp.

◆ operator*()

template<typename index_iterator_type , typename value_iterator_type >
reference Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator* ( ) const
inline
  • operator

Definition at line 175 of file Stokhos_SparseArray.hpp.

◆ operator->()

template<typename index_iterator_type , typename value_iterator_type >
pointer Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator-> ( ) const
inline

-> operator

Definition at line 181 of file Stokhos_SparseArray.hpp.

◆ operator++() [1/2]

template<typename index_iterator_type , typename value_iterator_type >
SparseArrayIterator & Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator++ ( )
inline

Prefix ++.

Definition at line 186 of file Stokhos_SparseArray.hpp.

◆ operator++() [2/2]

template<typename index_iterator_type , typename value_iterator_type >
SparseArrayIterator Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator++ ( int  )
inline

Postfix ++.

Definition at line 193 of file Stokhos_SparseArray.hpp.

◆ operator--() [1/2]

template<typename index_iterator_type , typename value_iterator_type >
SparseArrayIterator & Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator-- ( )
inline

Prefix –.

Definition at line 200 of file Stokhos_SparseArray.hpp.

◆ operator--() [2/2]

template<typename index_iterator_type , typename value_iterator_type >
SparseArrayIterator Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator-- ( int  )
inline

Postfix –.

Definition at line 207 of file Stokhos_SparseArray.hpp.

◆ operator<()

template<typename index_iterator_type , typename value_iterator_type >
bool Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::operator< ( const SparseArrayIterator< index_iterator_type, value_iterator_type > &  b) const
inline

Return true of *this < b.

Definition at line 214 of file Stokhos_SparseArray.hpp.

◆ value()

template<typename index_iterator_type , typename value_iterator_type >
value_reference Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::value ( ) const
inline

Return value associated with iterator.

Definition at line 220 of file Stokhos_SparseArray.hpp.

Member Data Documentation

◆ index_iterator

template<typename index_iterator_type , typename value_iterator_type >
index_iterator_type Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::index_iterator
protected

Index iterator.

Definition at line 227 of file Stokhos_SparseArray.hpp.

◆ value_iterator

template<typename index_iterator_type , typename value_iterator_type >
value_iterator_type Stokhos::SparseArrayIterator< index_iterator_type, value_iterator_type >::value_iterator
protected

Value iterator.

Definition at line 230 of file Stokhos_SparseArray.hpp.


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