SparseVector< Value >::SparseVectorIterator Class Reference

random access iterator for SparseVector including the hop() function to jump to the next non-sparse element More...

#include <OpenMS/DATASTRUCTURES/SparseVector.h>

List of all members.

Public Member Functions
	SparseVectorIterator (const SparseVectorIterator &source)
	copy constructor
virtual	~SparseVectorIterator ()
	destructor
SparseVectorIterator &	operator= (const SparseVectorIterator &source)
	assignment operator
SparseVectorIterator &	operator++ ()
	prefix increment
SparseVectorIterator	operator++ (int)
	postfix increment
SparseVectorIterator &	operator-- ()
	prefix decrement
SparseVectorIterator	operator-- (int)
	postfix decrement
ValueProxy	operator* ()
	dereference operator
const Value	operator* () const
	const dereference operator
ValueProxy	operator[] (size_type n)
	indexing
SparseVectorIterator &	operator+= (const size_type rhs)
	compound assignment +
SparseVectorIterator &	operator-= (const size_type rhs)
	compound assignment -
SparseVectorIterator	operator+ (const size_type rhs) const
	binary arithmetic +
difference_type	operator+ (const SparseVectorIterator rhs) const
	binary arithmetic +
SparseVectorIterator	operator- (const size_type rhs) const
	binary arithmetic -
difference_type	operator- (const SparseVectorIterator rhs) const
	binary arithmetic -
bool	operator!= (const SparseVectorIterator &other)
	inequality operator
bool	operator== (const SparseVectorIterator &other)
	equality operator
bool	operator< (const SparseVectorIterator &other)
	less than operator
bool	operator> (const SparseVectorIterator &other)
	greater than operator
bool	operator<= (const SparseVectorIterator &other)
	less or equal than operator
bool	operator>= (const SparseVectorIterator &other)
	greater or equal than operator
SparseVectorIterator &	hop ()
	go to the next nonempty position
size_type	position () const
	find out at what position the iterator is; useful in combination with hop()
Protected Member Functions
	SparseVectorIterator (SparseVector &vector, size_type position)
Protected Attributes
size_type	position_
	the position in the referred SparseVector
SparseVector &	vector_
	the referred SparseVector
map_const_iterator	valit_
	the position in the underlying map of SparseVector
Private Member Functions
	SparseVectorIterator ()
	Not implemented => private.
Friends
class	SparseVector< Value >
class	SparseVectorConstIterator

---

Detailed Description

template<typename Value>
class OpenMS::SparseVector< Value >::SparseVectorIterator

random access iterator for SparseVector including the hop() function to jump to the next non-sparse element

---

Constructor & Destructor Documentation

SparseVectorIterator

(

const SparseVectorIterator &

source

)

[inline]

copy constructor

virtual ~SparseVectorIterator

(

)

[inline, virtual]

destructor

SparseVectorIterator	(	SparseVector &	vector,
		size_type	position
	)			[inline, protected]

SparseVectorIterator

(

)

[private]

Not implemented => private.

Referenced by SparseVector< Value >::SparseVectorIterator::operator+(), and SparseVector< Value >::SparseVectorIterator::operator-().

---

Member Function Documentation

SparseVectorIterator& hop

(

)

[inline]

go to the next nonempty position

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::size_, SparseVector< Value >::SparseVectorIterator::valit_, SparseVector< Value >::values_, and SparseVector< Value >::SparseVectorIterator::vector_.

bool operator!=

(

const SparseVectorIterator &

other

)

[inline]

inequality operator

References SparseVector< Value >::SparseVectorIterator::position_, and SparseVector< Value >::SparseVectorIterator::vector_.

ValueProxy operator*

(

)

[inline]

dereference operator

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::size_, and SparseVector< Value >::SparseVectorIterator::vector_.

const Value operator*

(

)

const [inline]

const dereference operator

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::size_, and SparseVector< Value >::SparseVectorIterator::vector_.

SparseVectorIterator operator+

(

const size_type

rhs

)

const [inline]

binary arithmetic +

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::SparseVectorIterator::SparseVectorIterator(), and SparseVector< Value >::SparseVectorIterator::vector_.

difference_type operator+

(

const SparseVectorIterator

rhs

)

const [inline]

binary arithmetic +

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator operator++

(

int

)

[inline]

postfix increment

References SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator& operator++

(

)

[inline]

prefix increment

References SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator& operator+=

(

const size_type

rhs

)

[inline]

compound assignment +

References SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator operator-

(

const size_type

rhs

)

const [inline]

binary arithmetic -

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::SparseVectorIterator::SparseVectorIterator(), and SparseVector< Value >::SparseVectorIterator::vector_.

difference_type operator-

(

const SparseVectorIterator

rhs

)

const [inline]

binary arithmetic -

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator& operator--

(

)

[inline]

prefix decrement

References SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator operator--

(

int

)

[inline]

postfix decrement

References SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator& operator-=

(

const size_type

rhs

)

[inline]

compound assignment -

References SparseVector< Value >::SparseVectorIterator::position_.

bool operator<

(

const SparseVectorIterator &

other

)

[inline]

less than operator

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

bool operator<=

(

const SparseVectorIterator &

other

)

[inline]

less or equal than operator

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

SparseVectorIterator& operator=

(

const SparseVectorIterator &

source

)

[inline]

assignment operator

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::SparseVectorIterator::valit_, and SparseVector< Value >::SparseVectorIterator::vector_.

bool operator==

(

const SparseVectorIterator &

other

)

[inline]

equality operator

bool operator>

(

const SparseVectorIterator &

other

)

[inline]

greater than operator

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

bool operator>=

(

const SparseVectorIterator &

other

)

[inline]

greater or equal than operator

References SparseVector< Value >::SparseVectorIterator::position(), and SparseVector< Value >::SparseVectorIterator::position_.

ValueProxy operator[]

(

size_type

n

)

[inline]

indexing

References SparseVector< Value >::SparseVectorIterator::position_, SparseVector< Value >::size_, and SparseVector< Value >::SparseVectorIterator::vector_.

size_type position

(

)

const [inline]

find out at what position the iterator is; useful in combination with hop()

References SparseVector< Value >::SparseVectorIterator::position_.

Referenced by SparseVector< Value >::SparseVectorIterator::operator+(), SparseVector< Value >::SparseVectorIterator::operator-(), SparseVector< Value >::SparseVectorIterator::operator<(), SparseVector< Value >::SparseVectorIterator::operator<=(), SparseVector< Value >::SparseVectorIterator::operator>(), and SparseVector< Value >::SparseVectorIterator::operator>=().

---

Friends And Related Function Documentation

friend class SparseVector< Value > [friend]

friend class SparseVectorConstIterator [friend]

---

Member Data Documentation

size_type position_ [protected]

the position in the referred SparseVector

Referenced by SparseVector< Value >::SparseVectorIterator::hop(), SparseVector< Value >::SparseVectorIterator::operator!=(), SparseVector< Value >::SparseVectorIterator::operator*(), SparseVector< Value >::SparseVectorIterator::operator+(), SparseVector< Value >::SparseVectorIterator::operator++(), SparseVector< Value >::SparseVectorIterator::operator+=(), SparseVector< Value >::SparseVectorIterator::operator-(), SparseVector< Value >::SparseVectorIterator::operator--(), SparseVector< Value >::SparseVectorIterator::operator-=(), SparseVector< Value >::SparseVectorIterator::operator<(), SparseVector< Value >::SparseVectorIterator::operator<=(), SparseVector< Value >::SparseVectorIterator::operator=(), SparseVector< Value >::SparseVectorIterator::operator>(), SparseVector< Value >::SparseVectorIterator::operator>=(), SparseVector< Value >::SparseVectorIterator::operator[](), and SparseVector< Value >::SparseVectorIterator::position().

map_const_iterator valit_ [protected]

the position in the underlying map of SparseVector

Referenced by SparseVector< Value >::SparseVectorIterator::hop(), and SparseVector< Value >::SparseVectorIterator::operator=().

SparseVector& vector_ [protected]

the referred SparseVector

Referenced by SparseVector< Value >::SparseVectorIterator::hop(), SparseVector< Value >::SparseVectorIterator::operator!=(), SparseVector< Value >::SparseVectorIterator::operator*(), SparseVector< Value >::SparseVectorIterator::operator+(), SparseVector< Value >::SparseVectorIterator::operator-(), SparseVector< Value >::SparseVectorIterator::operator=(), and SparseVector< Value >::SparseVectorIterator::operator[]().