cv::SparseMatConstIterator Class Reference

#include <core.hpp>

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

List of all members.

Public Member Functions

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

Public Attributes

size_t hashidx
const SparseMatm
ucharptr

Detailed Description

Read-Only Sparse Matrix Iterator. Here is how to use the iterator to compute the sum of floating-point sparse matrix elements:

 SparseMatConstIterator it = m.begin(), it_end = m.end();
 double s = 0;
 CV_Assert( m.type() == CV_32F );
 for( ; it != it_end; ++it )
    s += it.value<float>();

Constructor & Destructor Documentation

cv::SparseMatConstIterator::SparseMatConstIterator (  )  [inline]

the default constructor

cv::SparseMatConstIterator::SparseMatConstIterator ( const SparseMat _m  ) 

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

cv::SparseMatConstIterator::SparseMatConstIterator ( const SparseMatConstIterator it  )  [inline]

the copy constructor


Member Function Documentation

const SparseMat::Node * cv::SparseMatConstIterator::node (  )  const [inline]

returns the current node of the sparse matrix. it.node->idx is the current element index

Reimplemented in cv::SparseMatIterator.

SparseMatConstIterator cv::SparseMatConstIterator::operator++ ( int   )  [inline]

moves iterator to the next element

Reimplemented in cv::SparseMatIterator, cv::SparseMatConstIterator_< _Tp >, and cv::SparseMatIterator_< _Tp >.

SparseMatConstIterator& cv::SparseMatConstIterator::operator++ (  ) 

moves iterator to the next element

Reimplemented in cv::SparseMatIterator, cv::SparseMatConstIterator_< _Tp >, and cv::SparseMatIterator_< _Tp >.

SparseMatConstIterator cv::SparseMatConstIterator::operator-- ( int   ) 

moves iterator to the previous element

SparseMatConstIterator& cv::SparseMatConstIterator::operator-- (  ) 

moves iterator to the previous element

SparseMatConstIterator & cv::SparseMatConstIterator::operator= ( const SparseMatConstIterator it  )  [inline]

the assignment operator

void cv::SparseMatConstIterator::seekEnd (  )  [inline]

moves iterator to the element after the last element

template<typename _Tp >
const _Tp & cv::SparseMatConstIterator::value (  )  const [inline]

template method returning the current matrix element

Reimplemented in cv::SparseMatIterator.


Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Dec 23 11:40:55 2010 for opencv by  doxygen 1.6.3