LocalRing Class Template Reference

Inheritance diagram for LocalRing:

LocalArray List of all members.

Detailed Description

template<class T, int Size>
class LocalRing< T, Size >

Local ring template class.

This class template provides a wrapping local array. References off the end (or beginning) of the array are wrapped to fall inside of the range of the array.

Author:
Bill Smart
Version:
1.0
Date:
May 2005

Definition at line 210 of file LocalArray.H.

Public Types

STL integration
typedef T value_type
typedef value_typepointer
typedef const value_typeconst_pointer
typedef value_typereference
typedef const value_typeconst_reference
typedef ptrdiff_t difference_type
typedef size_t size_type
typedef pointer iterator
typedef const_pointer const_iterator
typedef std::reverse_iterator<
iterator
reverse_iterator
typedef std::reverse_iterator<
const_iterator
const_reverse_iterator

Public Member Functions

 LocalRing ()
 LocalRing (const T &value)
 LocalRing (const LocalRing< T, Size > &ring)
 ~LocalRing ()
Element access
reference operator[] (const size_type index)
const_reference operator[] (const size_type index) const
reference operator() (const size_type index)
const_reference operator() (const size_type index) const

Private Member Functions

int wrap_index (const int index) const


Member Typedef Documentation

typedef T value_type

Reimplemented from LocalArray.

Definition at line 221 of file LocalArray.H.

typedef value_type* pointer

Reimplemented from LocalArray.

Definition at line 223 of file LocalArray.H.

typedef const value_type* const_pointer

Reimplemented from LocalArray.

Definition at line 224 of file LocalArray.H.

typedef value_type& reference

Reimplemented from LocalArray.

Definition at line 225 of file LocalArray.H.

typedef const value_type& const_reference

Reimplemented from LocalArray.

Definition at line 226 of file LocalArray.H.

typedef ptrdiff_t difference_type

Reimplemented from LocalArray.

Definition at line 228 of file LocalArray.H.

typedef size_t size_type

Reimplemented from LocalArray.

Definition at line 229 of file LocalArray.H.

typedef pointer iterator

Reimplemented from LocalArray.

Definition at line 231 of file LocalArray.H.

typedef const_pointer const_iterator

Reimplemented from LocalArray.

Definition at line 232 of file LocalArray.H.

typedef std::reverse_iterator<iterator> reverse_iterator

Reimplemented from LocalArray.

Definition at line 234 of file LocalArray.H.

typedef std::reverse_iterator<const_iterator> const_reverse_iterator

Reimplemented from LocalArray.

Definition at line 235 of file LocalArray.H.


Constructor & Destructor Documentation

LocalRing (  )  [inline]

Definition at line 212 of file LocalArray.H.

LocalRing ( const T &  value  )  [inline]

Definition at line 213 of file LocalArray.H.

LocalRing ( const LocalRing< T, Size > &  ring  )  [inline]

Definition at line 214 of file LocalArray.H.

~LocalRing (  )  [inline]

Definition at line 215 of file LocalArray.H.


Member Function Documentation

reference operator[] ( const size_type  index  )  [inline]

Reimplemented from LocalArray.

Definition at line 240 of file LocalArray.H.

References Array::operator[](), and wrap_index().

const_reference operator[] ( const size_type  index  )  const [inline]

Reimplemented from LocalArray.

Definition at line 241 of file LocalArray.H.

References Array::operator[](), and wrap_index().

reference operator() ( const size_type  index  )  [inline]

Reimplemented from LocalArray.

Definition at line 243 of file LocalArray.H.

References wrap_index().

const_reference operator() ( const size_type  index  )  const [inline]

Reimplemented from LocalArray.

Definition at line 244 of file LocalArray.H.

References wrap_index().

int wrap_index ( const int  index  )  const [inline, private]

Definition at line 250 of file LocalArray.H.

References LocalArray::size().

Referenced by operator()(), and operator[]().


The documentation for this class was generated from the following file:
Generated on Thu Feb 1 15:31:55 2007 for WURDE by  doxygen 1.5.1