arbb::range< T > Class Template Reference

A pair of iterators pointing to the beginning and the end of a data range that can be modified. More...

List of all members.

Public Types

typedef range_iterator< T > iterator
 An iterator to an element in the range.
typedef const_range_iterator< T > const_iterator
 An iterator to a constant element in the range.
typedef detail::range_element< T > element
 The type returned by dereferencing an iterator.

Public Member Functions

 range ()
 Default constructor.
 range (const range &other)
 Copy constructor.
void operator= (const range &other)
 Assignment operator.
iterator begin ()
 Returns an iterator pointing to the beginning of the range.
iterator end ()
 Returns an iterator representing the end of the range.
const_iterator begin () const
 Returns a const iterator pointing to the beginning of the range.
const_iterator end () const
 Returns a const iterator representing the end of the range.
uncaptured< usize >::type size ()
 Returns the number of elements addressed by this range.
bool empty ()
 Returns true if size() == 0, false otherwise.
element operator[] (typename uncaptured< usize >::type index)
 Returns a reference to the element at index.
const element operator[] (typename uncaptured< usize >::type index) const
 Returns a const reference to the element at index.
element at (typename uncaptured< usize >::type index)
 Returns a reference to the element at index.
const element at (typename uncaptured< usize >::type index) const
 Returns a const reference to the element at index.

Detailed Description

template<typename T>
class arbb::range< T >

A pair of iterators pointing to the beginning and the end of a data range that can be modified.

The range type is returned by data access functions such as arbb::dense::read_write_range().

See Also

arbb::const_range

Definition at line 37 of file range.hpp.


Member Typedef Documentation

template<typename T>
typedef range_iterator<T> arbb::range< T >::iterator

An iterator to an element in the range.

Definition at line 41 of file range.hpp.

template<typename T>
typedef const_range_iterator<T> arbb::range< T >::const_iterator

An iterator to a constant element in the range.

Definition at line 43 of file range.hpp.

template<typename T>
typedef detail::range_element<T> arbb::range< T >::element

The type returned by dereferencing an iterator.

Definition at line 45 of file range.hpp.


Constructor & Destructor Documentation

template<typename T>
arbb::range< T >::range (  ) 

Default constructor.

template<typename T>
arbb::range< T >::range ( const range< T > &  other  ) 

Copy constructor.


Member Function Documentation

template<typename T>
void arbb::range< T >::operator= ( const range< T > &  other  ) 

Assignment operator.

template<typename T>
iterator arbb::range< T >::begin (  ) 

Returns an iterator pointing to the beginning of the range.

template<typename T>
iterator arbb::range< T >::end (  ) 

Returns an iterator representing the end of the range.

template<typename T>
const_iterator arbb::range< T >::begin (  )  const

Returns a const iterator pointing to the beginning of the range.

template<typename T>
const_iterator arbb::range< T >::end (  )  const

Returns a const iterator representing the end of the range.

template<typename T>
uncaptured<usize>::type arbb::range< T >::size (  ) 

Returns the number of elements addressed by this range.

Equivalent to std::distance(begin(), end()).

template<typename T>
bool arbb::range< T >::empty (  ) 

Returns true if size() == 0, false otherwise.

template<typename T>
element arbb::range< T >::operator[] ( typename uncaptured< usize >::type  index  ) 

Returns a reference to the element at index.

template<typename T>
const element arbb::range< T >::operator[] ( typename uncaptured< usize >::type  index  )  const

Returns a const reference to the element at index.

template<typename T>
element arbb::range< T >::at ( typename uncaptured< usize >::type  index  ) 

Returns a reference to the element at index.

template<typename T>
const element arbb::range< T >::at ( typename uncaptured< usize >::type  index  )  const

Returns a const reference to the element at index.


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

Submit feedback on this help topic

Copyright © 2010, Intel Corporation. All rights reserved.