OpenCV  3.4.0-rc
Open Source Computer Vision
Public Types | Public Member Functions | List of all members
cv::SparseMatConstIterator_< _Tp > Class Template Reference

Template Read-Only Sparse Matrix Iterator Class. More...

#include "mat.hpp"

Inheritance diagram for cv::SparseMatConstIterator_< _Tp >:
cv::SparseMatConstIterator cv::SparseMatIterator_< _Tp >

Public Types

typedef std::forward_iterator_tag iterator_category
 

Public Member Functions

 SparseMatConstIterator_ ()
 the default constructor More...
 
 SparseMatConstIterator_ (const SparseMat_< _Tp > *_m)
 the full constructor setting the iterator to the first sparse matrix element More...
 
 SparseMatConstIterator_ (const SparseMat *_m)
 
 SparseMatConstIterator_ (const SparseMatConstIterator_ &it)
 the copy constructor More...
 
const _Tp & operator* () const
 the element access operator More...
 
SparseMatConstIterator_operator++ ()
 moves iterator to the next element More...
 
SparseMatConstIterator_ operator++ (int)
 moves iterator to the next element More...
 
SparseMatConstIterator_operator= (const SparseMatConstIterator_ &it)
 the assignment operator More...
 
- Public Member Functions inherited from cv::SparseMatConstIterator
 SparseMatConstIterator ()
 the default constructor More...
 
 SparseMatConstIterator (const SparseMat *_m)
 the full constructor setting the iterator to the first sparse matrix element More...
 
 SparseMatConstIterator (const SparseMatConstIterator &it)
 the copy constructor More...
 
const SparseMat::Nodenode () const
 returns the current node of the sparse matrix. it.node->idx is the current element index More...
 
SparseMatConstIteratoroperator++ ()
 moves iterator to the next element More...
 
SparseMatConstIterator operator++ (int)
 moves iterator to the next element More...
 
SparseMatConstIteratoroperator-- ()
 moves iterator to the previous element More...
 
SparseMatConstIterator operator-- (int)
 moves iterator to the previous element More...
 
SparseMatConstIteratoroperator= (const SparseMatConstIterator &it)
 the assignment operator More...
 
void seekEnd ()
 moves iterator to the element after the last element More...
 
template<typename _Tp >
const _Tp & value () const
 template method returning the current matrix element More...
 

Additional Inherited Members

- Public Attributes inherited from cv::SparseMatConstIterator
size_t hashidx
 
const SparseMatm
 
ucharptr
 

Detailed Description

template<typename _Tp>
class cv::SparseMatConstIterator_< _Tp >

Template Read-Only Sparse Matrix Iterator Class.

This is the derived from SparseMatConstIterator class that introduces more convenient operator *() for accessing the current element.

Member Typedef Documentation

§ iterator_category

template<typename _Tp>
typedef std::forward_iterator_tag cv::SparseMatConstIterator_< _Tp >::iterator_category

Constructor & Destructor Documentation

§ SparseMatConstIterator_() [1/4]

template<typename _Tp>
cv::SparseMatConstIterator_< _Tp >::SparseMatConstIterator_ ( )

the default constructor

§ SparseMatConstIterator_() [2/4]

template<typename _Tp>
cv::SparseMatConstIterator_< _Tp >::SparseMatConstIterator_ ( const SparseMat_< _Tp > *  _m)

the full constructor setting the iterator to the first sparse matrix element

§ SparseMatConstIterator_() [3/4]

template<typename _Tp>
cv::SparseMatConstIterator_< _Tp >::SparseMatConstIterator_ ( const SparseMat _m)

§ SparseMatConstIterator_() [4/4]

template<typename _Tp>
cv::SparseMatConstIterator_< _Tp >::SparseMatConstIterator_ ( const SparseMatConstIterator_< _Tp > &  it)

the copy constructor

Member Function Documentation

§ operator*()

template<typename _Tp>
const _Tp& cv::SparseMatConstIterator_< _Tp >::operator* ( ) const

the element access operator

§ operator++() [1/2]

template<typename _Tp>
SparseMatConstIterator_& cv::SparseMatConstIterator_< _Tp >::operator++ ( )

moves iterator to the next element

§ operator++() [2/2]

template<typename _Tp>
SparseMatConstIterator_ cv::SparseMatConstIterator_< _Tp >::operator++ ( int  )

moves iterator to the next element

§ operator=()

template<typename _Tp>
SparseMatConstIterator_& cv::SparseMatConstIterator_< _Tp >::operator= ( const SparseMatConstIterator_< _Tp > &  it)

the assignment operator


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