Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr > Class Template Reference

#include <hashedSMatrixIterator.hh>

Inheritance diagram for concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >:
concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr > concepts::OutputOperator

Classes

struct  MatrixType
 Non-constant matrix for non-constant iterator. More...
 
struct  MatrixType< _Tp_, const _Tp_ &, const _Tp_ * >
 Constant matrix for constant iterator. More...
 

Public Types

typedef _HashedSMatrix_iterator< _Tp, _Tp &, _Tp * > iterator
 
typedef _HashedSMatrix_iterator< _Tp, const _Tp &, const _Tp * > const_iterator
 
typedef std::forward_iterator_tag iterator_category
 
typedef _Tp value_type
 
typedef _Ptr pointer
 
typedef _Ref reference
 
typedef size_t size_type
 
typedef ptrdiff_t difference_type
 
typedef _HashedSMatrix_iterator _Self
 
typedef _Matrix_iterator_base< _Tp, _Ref, _Ptr_Base
 
typedef MatrixType< _Tp, _Ref, _Ptr >::type matrix_type
 
typedef _Base::return_type return_type
 

Public Member Functions

 _HashedSMatrix_iterator (matrix_type &m, const unsigned int r=0)
 
 _HashedSMatrix_iterator ()
 Constructor. Iterator stands at the end of any matrix.
 
template<class _RefR , class _PtrR >
 _HashedSMatrix_iterator (const _HashedSMatrix_iterator< _Tp, _RefR, _PtrR > &__x)
 Copy constructor. Also from iterator to constant iterator.
 
reference operator* () const
 Dereferencation.
 
pointer operator-> () const
 Returns a pointer to the value.
 
template<class _RefR , class _PtrR >
_Selfoperator= (const _HashedSMatrix_iterator< _Tp, _RefR, _PtrR > &__x)
 Assignment.
 
_Selfoperator++ ()
 Pre-increment operator.
 
_Self operator++ (int)
 Post-increment operator.
 
_Self pre_increment ()
 Pre-increment operator, exportable to Python.
 
_Self post_increment ()
 Post-increment operator, exportable to Python.
 
HashedSparseMatrix< _Tp >::Value * v () const
 Data defining the position of the iterator.
 
int hashBits () const
 
int pPerRow () const
 
int nofPages () const
 
int p () const
 
int pNextRow () const
 
HashedSparseMatrix< _Tp >::Value ** page () const
 
const unsigned int nofRows () const
 Number of rows.
 
const unsigned int nofCols () const
 Number of columns.
 
unsigned int row () const
 Row.
 
unsigned int col () const
 Column.
 
bool last () const
 Returns true, if iterator is behind the last entry.
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Protected Attributes

const unsigned int nofRows_
 Number of rows and columns.
 
const unsigned int nofCols_
 
unsigned int row_
 Current row and column.
 
unsigned int col_
 
bool last_
 Iterator is behind the last entrance.
 

Detailed Description

template<class _Tp, class _Ref, class _Ptr>
class concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >

STL like iterator for hashed sparse matrices

Author
Kersten Schmidt, 2005

Definition at line 28 of file hashedSMatrixIterator.hh.

Member Typedef Documentation

◆ _Base

◆ _Self

◆ const_iterator

Definition at line 32 of file hashedSMatrixIterator.hh.

◆ difference_type

Definition at line 42 of file hashedSMatrixIterator.hh.

◆ iterator

◆ iterator_category

template<class _Tp , class _Ref , class _Ptr >
typedef std::forward_iterator_tag concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::iterator_category

Definition at line 37 of file hashedSMatrixIterator.hh.

◆ matrix_type

Definition at line 45 of file hashedSMatrixIterator.hh.

◆ pointer

Definition at line 39 of file hashedSMatrixIterator.hh.

◆ reference

Definition at line 40 of file hashedSMatrixIterator.hh.

◆ return_type

template<class _Tp , class _Ref , class _Ptr >
typedef _Base::return_type concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::return_type

Definition at line 46 of file hashedSMatrixIterator.hh.

◆ size_type

Definition at line 41 of file hashedSMatrixIterator.hh.

◆ value_type

Definition at line 38 of file hashedSMatrixIterator.hh.

Constructor & Destructor Documentation

◆ _HashedSMatrix_iterator() [1/2]

template<class _Tp , class _Ref , class _Ptr >
concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::_HashedSMatrix_iterator ( matrix_type m,
const unsigned int  r = 0 
)

Constructor

Parameters
mmatrix
rrow

◆ _HashedSMatrix_iterator() [2/2]

template<class _Tp , class _Ref , class _Ptr >
template<class _RefR , class _PtrR >
concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::_HashedSMatrix_iterator ( const _HashedSMatrix_iterator< _Tp, _RefR, _PtrR > &  __x)
inline

Copy constructor. Also from iterator to constant iterator.

Definition at line 58 of file hashedSMatrixIterator.hh.

Member Function Documentation

◆ col()

template<class _Tp , class _Ref , class _Ptr >
unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::col ( ) const
inlineinherited

Column.

Definition at line 75 of file matrixIterator.hh.

◆ hashBits()

template<class _Tp , class _Ref , class _Ptr >
int concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::hashBits ( ) const
inline

Definition at line 99 of file hashedSMatrixIterator.hh.

◆ info()

template<class _Tp , class _Ref , class _Ptr >
virtual std::ostream & concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >.

◆ last()

template<class _Tp , class _Ref , class _Ptr >
bool concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::last ( ) const
inlineinherited

Returns true, if iterator is behind the last entry.

Definition at line 77 of file matrixIterator.hh.

◆ nofCols()

template<class _Tp , class _Ref , class _Ptr >
const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofCols ( ) const
inlineinherited

Number of columns.

Definition at line 71 of file matrixIterator.hh.

◆ nofPages()

template<class _Tp , class _Ref , class _Ptr >
int concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::nofPages ( ) const
inline

Definition at line 101 of file hashedSMatrixIterator.hh.

◆ nofRows()

template<class _Tp , class _Ref , class _Ptr >
const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofRows ( ) const
inlineinherited

Number of rows.

Definition at line 69 of file matrixIterator.hh.

◆ operator*()

template<class _Tp , class _Ref , class _Ptr >
reference concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::operator* ( ) const
inline

Dereferencation.

Definition at line 67 of file hashedSMatrixIterator.hh.

◆ operator->()

template<class _Tp , class _Ref , class _Ptr >
pointer concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::operator-> ( ) const
inline

Returns a pointer to the value.

Definition at line 72 of file hashedSMatrixIterator.hh.

◆ operator=()

Assignment.

Definition at line 79 of file hashedSMatrixIterator.hh.

◆ p()

template<class _Tp , class _Ref , class _Ptr >
int concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::p ( ) const
inline

Definition at line 102 of file hashedSMatrixIterator.hh.

◆ page()

template<class _Tp , class _Ref , class _Ptr >
HashedSparseMatrix< _Tp >::Value ** concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::page ( ) const
inline

Definition at line 104 of file hashedSMatrixIterator.hh.

◆ pNextRow()

template<class _Tp , class _Ref , class _Ptr >
int concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::pNextRow ( ) const
inline

Definition at line 103 of file hashedSMatrixIterator.hh.

◆ pPerRow()

template<class _Tp , class _Ref , class _Ptr >
int concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::pPerRow ( ) const
inline

Definition at line 100 of file hashedSMatrixIterator.hh.

◆ row()

template<class _Tp , class _Ref , class _Ptr >
unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::row ( ) const
inlineinherited

Row.

Definition at line 73 of file matrixIterator.hh.

◆ v()

template<class _Tp , class _Ref , class _Ptr >
HashedSparseMatrix< _Tp >::Value * concepts::_HashedSMatrix_iterator< _Tp, _Ref, _Ptr >::v ( ) const
inline

Data defining the position of the iterator.

Definition at line 98 of file hashedSMatrixIterator.hh.

Member Data Documentation

◆ col_

template<class _Tp , class _Ref , class _Ptr >
unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::col_
protectedinherited

Definition at line 93 of file matrixIterator.hh.

◆ last_

template<class _Tp , class _Ref , class _Ptr >
bool concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::last_
protectedinherited

Iterator is behind the last entrance.

Definition at line 95 of file matrixIterator.hh.

◆ nofCols_

template<class _Tp , class _Ref , class _Ptr >
const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofCols_
protectedinherited

Definition at line 91 of file matrixIterator.hh.

◆ nofRows_

template<class _Tp , class _Ref , class _Ptr >
const unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::nofRows_
protectedinherited

Number of rows and columns.

Definition at line 91 of file matrixIterator.hh.

◆ row_

template<class _Tp , class _Ref , class _Ptr >
unsigned int concepts::_Matrix_iterator_base< _Tp, _Ref, _Ptr >::row_
protectedinherited

Current row and column.

Definition at line 93 of file matrixIterator.hh.


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