Boost.uBlas 1.49
Linear Algebra in C++: matrices, vectors and numeric algorithms

boost::numeric::ublas::vector< T, A >::const_iterator Class Reference

#include <vector.hpp>

Inheritance diagram for boost::numeric::ublas::vector< T, A >::const_iterator:
Collaboration diagram for boost::numeric::ublas::vector< T, A >::const_iterator:

List of all members.

Public Types

typedef vector container_type
typedef difference_type derived_difference_type
typedef const_iterator derived_iterator_type
typedef value_type derived_value_type
typedef vector::difference_type difference_type
typedef const vector::pointer pointer
typedef vector::const_reference reference
typedef vector::value_type value_type

Public Member Functions

BOOST_UBLAS_INLINE const_iterator ()
BOOST_UBLAS_INLINE const_iterator (const self_type &v, const const_subiterator_type &it)
BOOST_UBLAS_INLINE const_iterator (const typename self_type::iterator &it)
BOOST_UBLAS_INLINE
container_const_reference
assign (const container_type *c)
BOOST_UBLAS_INLINE size_type index () const
 return the index of the element referenced by the iterator
BOOST_UBLAS_INLINE bool operator!= (const derived_iterator_type &it) const
BOOST_UBLAS_INLINE const
container_type
operator() () const
BOOST_UBLAS_INLINE const_reference operator* () const
 Dereference an iterator Dereference an iterator: a bounds' check is done before returning the value. A bad_index() expection is returned if out of bounds.
BOOST_UBLAS_INLINE
derived_iterator_type 
operator+ (derived_difference_type n) const
BOOST_UBLAS_INLINE const_iteratoroperator++ ()
 Increment by 1 the position of the iterator.
BOOST_UBLAS_INLINE
derived_iterator_type 
operator++ (int)
BOOST_UBLAS_INLINE const_iteratoroperator+= (difference_type n)
 Increment by n the position of the iterator.
BOOST_UBLAS_INLINE difference_type operator- (const const_iterator &it) const
 Return the different in number of positions between 2 iterators.
BOOST_UBLAS_INLINE
derived_iterator_type 
operator- (derived_difference_type n) const
BOOST_UBLAS_INLINE
derived_iterator_type 
operator-- (int)
BOOST_UBLAS_INLINE const_iteratoroperator-- ()
 Decrement by 1 the position of the iterator.
BOOST_UBLAS_INLINE const_iteratoroperator-= (difference_type n)
 Decrement by n the position of the iterator.
BOOST_UBLAS_INLINE bool operator< (const const_iterator &it) const
 compare the value of two iterators
BOOST_UBLAS_INLINE bool operator<= (const derived_iterator_type &it) const
BOOST_UBLAS_INLINE const_iteratoroperator= (const const_iterator &it)
 assign the value of an iterator to the iterator
BOOST_UBLAS_INLINE bool operator== (const const_iterator &it) const
 compare the value of two itetarors
BOOST_UBLAS_INLINE bool operator> (const derived_iterator_type &it) const
BOOST_UBLAS_INLINE bool operator>= (const derived_iterator_type &it) const
BOOST_UBLAS_INLINE const_reference operator[] (difference_type n) const
 Dereference an iterator at the n-th forward value Dereference an iterator at the n-th forward value, that is the value pointed by iterator+n.
BOOST_UBLAS_INLINE bool same_closure (const container_const_reference &cr) const

Private Attributes

const_subiterator_type it_

Friends

class iterator
BOOST_UBLAS_INLINE friend
derived_iterator_type 
operator+ (const derived_iterator_type &d, derived_difference_type n)
BOOST_UBLAS_INLINE friend
derived_iterator_type 
operator+ (derived_difference_type n, const derived_iterator_type &d)
BOOST_UBLAS_INLINE friend
derived_iterator_type 
operator++ (derived_iterator_type &d, int)
BOOST_UBLAS_INLINE friend
derived_iterator_type 
operator- (const derived_iterator_type &d, derived_difference_type n)
BOOST_UBLAS_INLINE friend
derived_iterator_type 
operator-- (derived_iterator_type &d, int)

Detailed Description

template<class T, class A>
class boost::numeric::ublas::vector< T, A >::const_iterator

Definition at line 498 of file vector.hpp.


Member Typedef Documentation

Definition at line 503 of file vector.hpp.

Definition at line 504 of file vector.hpp.

Definition at line 505 of file vector.hpp.

template<class T, class A>
typedef const vector::pointer boost::numeric::ublas::vector< T, A >::const_iterator::pointer

Definition at line 506 of file vector.hpp.

Definition at line 31 of file iterator.hpp.


Constructor & Destructor Documentation

template<class T, class A>
BOOST_UBLAS_INLINE boost::numeric::ublas::vector< T, A >::const_iterator::const_iterator ( ) [inline]

Definition at line 514 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE boost::numeric::ublas::vector< T, A >::const_iterator::const_iterator ( const self_type v,
const const_subiterator_type it 
) [inline]

Definition at line 517 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE boost::numeric::ublas::vector< T, A >::const_iterator::const_iterator ( const typename self_type::iterator it) [inline]

Definition at line 520 of file vector.hpp.


Member Function Documentation

template<class T, class A>
BOOST_UBLAS_INLINE const_iterator& boost::numeric::ublas::vector< T, A >::const_iterator::operator++ ( ) [inline]

Increment by 1 the position of the iterator.

Returns:
a reference to the const iterator

Definition at line 530 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_iterator& boost::numeric::ublas::vector< T, A >::const_iterator::operator-- ( ) [inline]

Decrement by 1 the position of the iterator.

Returns:
a reference to the const iterator

Definition at line 538 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_iterator& boost::numeric::ublas::vector< T, A >::const_iterator::operator+= ( difference_type  n) [inline]

Increment by n the position of the iterator.

Returns:
a reference to the const iterator

Definition at line 546 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_iterator& boost::numeric::ublas::vector< T, A >::const_iterator::operator-= ( difference_type  n) [inline]

Decrement by n the position of the iterator.

Returns:
a reference to the const iterator

Definition at line 554 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE difference_type boost::numeric::ublas::vector< T, A >::const_iterator::operator- ( const const_iterator it) const [inline]

Return the different in number of positions between 2 iterators.

Definition at line 561 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_reference boost::numeric::ublas::vector< T, A >::const_iterator::operator* ( ) const [inline]

Dereference an iterator Dereference an iterator: a bounds' check is done before returning the value. A bad_index() expection is returned if out of bounds.

Returns:
a const reference to the value pointed by the iterator

Definition at line 570 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_reference boost::numeric::ublas::vector< T, A >::const_iterator::operator[] ( difference_type  n) const [inline]

Dereference an iterator at the n-th forward value Dereference an iterator at the n-th forward value, that is the value pointed by iterator+n.

A bounds' check is done before returning the value. A bad_index() expection is returned if out of bounds.

Returns:
a const reference

Definition at line 580 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE size_type boost::numeric::ublas::vector< T, A >::const_iterator::index ( ) const [inline]

return the index of the element referenced by the iterator

Definition at line 587 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE const_iterator& boost::numeric::ublas::vector< T, A >::const_iterator::operator= ( const const_iterator it) [inline]

assign the value of an iterator to the iterator

Definition at line 595 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE bool boost::numeric::ublas::vector< T, A >::const_iterator::operator== ( const const_iterator it) const [inline]

compare the value of two itetarors

Returns:
true if they reference the same element

Definition at line 605 of file vector.hpp.

template<class T, class A>
BOOST_UBLAS_INLINE bool boost::numeric::ublas::vector< T, A >::const_iterator::operator< ( const const_iterator it) const [inline]

compare the value of two iterators

Returns:
return true if the left-hand-side iterator refers to a value placed before the right-hand-side iterator

Definition at line 614 of file vector.hpp.

BOOST_UBLAS_INLINE const container_type& boost::numeric::ublas::container_const_reference< vector >::operator() ( ) const [inline, inherited]

Definition at line 41 of file iterator.hpp.

BOOST_UBLAS_INLINE container_const_reference& boost::numeric::ublas::container_const_reference< vector >::assign ( const container_type *  c) [inline, inherited]

Definition at line 46 of file iterator.hpp.

BOOST_UBLAS_INLINE bool boost::numeric::ublas::container_const_reference< vector >::same_closure ( const container_const_reference< vector > &  cr) const [inline, inherited]

Definition at line 53 of file iterator.hpp.

Definition at line 220 of file iterator.hpp.

Definition at line 233 of file iterator.hpp.

Definition at line 273 of file iterator.hpp.

Definition at line 278 of file iterator.hpp.

Definition at line 283 of file iterator.hpp.

Definition at line 288 of file iterator.hpp.


Friends And Related Function Documentation

template<class T, class A>
friend class iterator [friend]

Definition at line 622 of file vector.hpp.

BOOST_UBLAS_INLINE friend derived_iterator_type operator++ ( derived_iterator_type d,
int   
) [friend, inherited]

Definition at line 227 of file iterator.hpp.

BOOST_UBLAS_INLINE friend derived_iterator_type operator-- ( derived_iterator_type d,
int   
) [friend, inherited]

Definition at line 240 of file iterator.hpp.

BOOST_UBLAS_INLINE friend derived_iterator_type operator+ ( const derived_iterator_type d,
derived_difference_type  n 
) [friend, inherited]

Definition at line 251 of file iterator.hpp.

BOOST_UBLAS_INLINE friend derived_iterator_type operator+ ( derived_difference_type  n,
const derived_iterator_type d 
) [friend, inherited]

Definition at line 256 of file iterator.hpp.

BOOST_UBLAS_INLINE friend derived_iterator_type operator- ( const derived_iterator_type d,
derived_difference_type  n 
) [friend, inherited]

Definition at line 266 of file iterator.hpp.


Member Data Documentation

template<class T, class A>
const_subiterator_type boost::numeric::ublas::vector< T, A >::const_iterator::it_ [private]

Definition at line 620 of file vector.hpp.


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