LocalTorus Class Template Reference

Inheritance diagram for LocalTorus:

List of all members.

---

Detailed Description

template<class T, int Rows, int Columns>
class LocalTorus< T, Rows, Columns >

Local torus template class.

This class template provides a wrapping 2d local array. Row and column 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 260 of file LocalArray.H.

Public Types
STL integration
typedef T	value_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef value_type &	reference
typedef const value_type &	const_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
	LocalTorus ()
	LocalTorus (const T &value)
	LocalTorus (const LocalTorus< T, Rows, Columns > &torus)
	~LocalTorus ()
Element access
reference	operator() (const size_type row, const size_type column)
const_reference	operator() (const size_type row, const size_type column) const
Private Member Functions
int	wrap_index (const int index, const int size) const

---

Member Typedef Documentation

typedef T value_type

Reimplemented from LocalArray2d.

Definition at line 271 of file LocalArray.H.

typedef value_type* pointer

Reimplemented from LocalArray2d.

Definition at line 273 of file LocalArray.H.

typedef const value_type* const_pointer

Reimplemented from LocalArray2d.

Definition at line 274 of file LocalArray.H.

typedef value_type& reference

Reimplemented from LocalArray2d.

Definition at line 275 of file LocalArray.H.

typedef const value_type& const_reference

Reimplemented from LocalArray2d.

Definition at line 276 of file LocalArray.H.

typedef ptrdiff_t difference_type

Reimplemented from LocalArray2d.

Definition at line 278 of file LocalArray.H.

typedef size_t size_type

Reimplemented from LocalArray2d.

Definition at line 279 of file LocalArray.H.

typedef pointer iterator

Reimplemented from LocalArray2d.

Definition at line 281 of file LocalArray.H.

typedef const_pointer const_iterator

Reimplemented from LocalArray2d.

Definition at line 282 of file LocalArray.H.

typedef std::reverse_iterator<iterator> reverse_iterator

Reimplemented from LocalArray2d.

Definition at line 284 of file LocalArray.H.

typedef std::reverse_iterator<const_iterator> const_reverse_iterator

Reimplemented from LocalArray2d.

Definition at line 285 of file LocalArray.H.

---

Constructor & Destructor Documentation

LocalTorus

(

)

[inline]

Definition at line 262 of file LocalArray.H.

LocalTorus

(

const T &

value

)

[inline]

Definition at line 263 of file LocalArray.H.

LocalTorus

(

const LocalTorus< T, Rows, Columns > &

torus

)

[inline]

Definition at line 264 of file LocalArray.H.

~LocalTorus

(

)

[inline]

Definition at line 265 of file LocalArray.H.

---

Member Function Documentation

reference operator()	(	const size_type	row,
		const size_type	column
	)			[inline]

Reimplemented from LocalArray2d.

Definition at line 290 of file LocalArray.H.

References LocalArray2d::columns(), LocalArray2d::rows(), and wrap_index().

const_reference operator()	(	const size_type	row,
		const size_type	column
	)			const [inline]

Reimplemented from LocalArray2d.

Definition at line 292 of file LocalArray.H.

References LocalArray2d::columns(), LocalArray2d::rows(), and wrap_index().

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

Definition at line 301 of file LocalArray.H.

Referenced by operator()().

---

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

• /home/fwph/code/wurde/rde/core/LocalArray.H

---