cv::MatConstIterator_< _Tp > Class Template Reference

Matrix read-only iterator. More...

#include <opencv2/core/mat.hpp>

Inheritance diagram for cv::MatConstIterator_< _Tp >:

Collaboration diagram for cv::MatConstIterator_< _Tp >:

Public Types
typedef ptrdiff_t	difference_type
typedef std::random_access_iterator_tag	iterator_category
typedef const _Tp *	pointer
typedef const _Tp &	reference
typedef _Tp	value_type

Public Member Functions
	MatConstIterator_ ()
	default constructor More...
	MatConstIterator_ (const Mat_< _Tp > *_m)
	constructor that sets the iterator to the beginning of the matrix More...
	MatConstIterator_ (const Mat_< _Tp > *_m, int _row, int _col=0)
	constructor that sets the iterator to the specified element of the matrix More...
	MatConstIterator_ (const Mat_< _Tp > *_m, Point _pt)
	constructor that sets the iterator to the specified element of the matrix More...
	MatConstIterator_ (const Mat_< _Tp > *_m, const int *_idx)
	constructor that sets the iterator to the specified element of the matrix More...
	MatConstIterator_ (const MatConstIterator_ &it)
	copy constructor More...
ptrdiff_t	lpos () const
const _Tp &	operator* () const
	returns the current matrix element More...
MatConstIterator_ &	operator++ ()
	increments the iterator More...
MatConstIterator_	operator++ (int)
	increments the iterator More...
MatConstIterator_ &	operator+= (ptrdiff_t ofs)
	shifts the iterator forward by the specified number of elements More...
MatConstIterator_ &	operator-- ()
	decrements the iterator More...
MatConstIterator_	operator-- (int)
	decrements the iterator More...
MatConstIterator_ &	operator-= (ptrdiff_t ofs)
	shifts the iterator backward by the specified number of elements More...
MatConstIterator_ &	operator= (const MatConstIterator_ &it)
	copy operator More...
const _Tp &	operator[] (ptrdiff_t i) const
	returns the i-th matrix element, relative to the current More...
void	pos (int *_idx) const
	returns the current iterator position More...
Point	pos () const
	returns the current iterator position More...
void	seek (ptrdiff_t ofs, bool relative=false)
void	seek (const int *_idx, bool relative=false)

Public Attributes
size_t	elemSize
const Mat *	m
const uchar *	ptr
const uchar *	sliceEnd
const uchar *	sliceStart

Detailed Description

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

Matrix read-only iterator.

Member Typedef Documentation

difference_type

template<typename _Tp>

typedef ptrdiff_t cv::MatConstIterator_< _Tp >::difference_type

iterator_category

template<typename _Tp>

typedef std::random_access_iterator_tag cv::MatConstIterator_< _Tp >::iterator_category

pointer

template<typename _Tp>

typedef const _Tp* cv::MatConstIterator_< _Tp >::pointer

reference

template<typename _Tp>

typedef const _Tp& cv::MatConstIterator_< _Tp >::reference

value_type

template<typename _Tp>

typedef _Tp cv::MatConstIterator_< _Tp >::value_type

Constructor & Destructor Documentation

MatConstIterator_() [1/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_

(

)

default constructor

MatConstIterator_() [2/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_

(

const Mat_< _Tp > *

_m

)

constructor that sets the iterator to the beginning of the matrix

MatConstIterator_() [3/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_	(	const Mat_< _Tp > *	_m,
		int	_row,
		int	_col = 0
	)

constructor that sets the iterator to the specified element of the matrix

MatConstIterator_() [4/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_	(	const Mat_< _Tp > *	_m,
		Point	_pt
	)

constructor that sets the iterator to the specified element of the matrix

MatConstIterator_() [5/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_	(	const Mat_< _Tp > *	_m,
		const int *	_idx
	)

constructor that sets the iterator to the specified element of the matrix

MatConstIterator_() [6/6]

template<typename _Tp>

cv::MatConstIterator_< _Tp >::MatConstIterator_

(

const MatConstIterator_< _Tp > &

it

)

copy constructor

Member Function Documentation

lpos()

ptrdiff_t cv::MatConstIterator::lpos ( ) const

inherited

operator*()

template<typename _Tp>

const _Tp& cv::MatConstIterator_< _Tp >::operator*

(

)

const

returns the current matrix element

operator++() [1/2]

template<typename _Tp>

MatConstIterator_& cv::MatConstIterator_< _Tp >::operator++

(

)

increments the iterator

operator++() [2/2]

template<typename _Tp>

MatConstIterator_ cv::MatConstIterator_< _Tp >::operator++

(

int

)

increments the iterator

operator+=()

template<typename _Tp>

MatConstIterator_& cv::MatConstIterator_< _Tp >::operator+=

(

ptrdiff_t

ofs

)

shifts the iterator forward by the specified number of elements

operator--() [1/2]

template<typename _Tp>

MatConstIterator_& cv::MatConstIterator_< _Tp >::operator--

(

)

decrements the iterator

operator--() [2/2]

template<typename _Tp>

MatConstIterator_ cv::MatConstIterator_< _Tp >::operator--

(

int

)

decrements the iterator

operator-=()

template<typename _Tp>

MatConstIterator_& cv::MatConstIterator_< _Tp >::operator-=

(

ptrdiff_t

ofs

)

shifts the iterator backward by the specified number of elements

operator=()

template<typename _Tp>

MatConstIterator_& cv::MatConstIterator_< _Tp >::operator=

(

const MatConstIterator_< _Tp > &

it

)

copy operator

operator[]()

template<typename _Tp>

const _Tp& cv::MatConstIterator_< _Tp >::operator[]

(

ptrdiff_t

i

)

const

returns the i-th matrix element, relative to the current

pos() [1/2]

void cv::MatConstIterator::pos ( int *  _idx ) const

inherited

returns the current iterator position

pos() [2/2]

template<typename _Tp>

Point cv::MatConstIterator_< _Tp >::pos

(

)

const

returns the current iterator position

seek() [1/2]

void cv::MatConstIterator::seek ( ptrdiff_t  ofs, bool  relative = false  )

inherited

seek() [2/2]

void cv::MatConstIterator::seek ( const int *  _idx, bool  relative = false  )

inherited

Member Data Documentation

elemSize

size_t cv::MatConstIterator::elemSize

inherited

m

const Mat* cv::MatConstIterator::m

inherited

ptr

const uchar* cv::MatConstIterator::ptr

inherited

sliceEnd

const uchar* cv::MatConstIterator::sliceEnd

inherited

sliceStart

const uchar* cv::MatConstIterator::sliceStart

inherited

---

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

• opencv2/core/mat.hpp