rutz::fixed_block< T > Class Template Reference

A dynamically-allocated array whose size is fixed at construction. More...

#include <rutz/arrays.h>

Collaboration diagram for rutz::fixed_block< T >:

[legend]

List of all members.

Public Types
typedef T	value_type
	STL value type.
typedef T *	pointer
	STL pointer type.
typedef const T *	const_pointer
	STL const pointer type.
typedef T &	reference
	STL reference type.
typedef const T &	const_reference
	STL const reference type.
typedef pointer	iterator
	STL iterator type.
typedef const_pointer	const_iterator
	STL const iterator type.
typedef size_t	size_type
	STL size type.
typedef ptrdiff_t	difference_type
	STL iterator difference type.
Public Member Functions
	fixed_block (size_type n)
	Construct with a given size.
	~fixed_block ()
	Destructor.
template<class Itr >
	fixed_block (Itr itr, Itr end)
	Construct by copying from a given iterator range.
iterator	begin ()
	Iterator to array start.
iterator	end ()
	Iterator to array one-past-the-end.
const_iterator	begin () const
	Const iterator to array start.
const_iterator	end () const
	Const iterator to array one-past-the-end.
reference	operator[] (size_type n)
	Unchecked non-const array index.
const_reference	operator[] (size_type n) const
	Unchecked const array index.
reference	at (size_type n)
	Checked non-const array index (rutz::out_of_range thrown on bounds error).
const_reference	at (size_type n) const
	Checked const array index (rutz::out_of_range thrown on bounds error).
size_type	size () const
	Size of array.
size_type	max_size () const
	Maximum size of array type.
bool	is_empty () const
	Query whether size is zero.
void	swap (fixed_block &other)
	Swap with another fixed_block.

---

Detailed Description

template<class T>
class rutz::fixed_block< T >

A dynamically-allocated array whose size is fixed at construction.

Copying and assignment are not allowed.

Definition at line 157 of file arrays.h.

---

Member Typedef Documentation

template<class T>

typedef const_pointer rutz::fixed_block< T >::const_iterator

STL const iterator type.

Definition at line 186 of file arrays.h.

template<class T>

typedef const T* rutz::fixed_block< T >::const_pointer

STL const pointer type.

Definition at line 181 of file arrays.h.

template<class T>

typedef const T& rutz::fixed_block< T >::const_reference

STL const reference type.

Definition at line 183 of file arrays.h.

template<class T>

typedef ptrdiff_t rutz::fixed_block< T >::difference_type

STL iterator difference type.

Definition at line 189 of file arrays.h.

template<class T>

typedef pointer rutz::fixed_block< T >::iterator

STL iterator type.

Definition at line 185 of file arrays.h.

template<class T>

typedef T* rutz::fixed_block< T >::pointer

STL pointer type.

Definition at line 180 of file arrays.h.

template<class T>

typedef T& rutz::fixed_block< T >::reference

STL reference type.

Definition at line 182 of file arrays.h.

template<class T>

typedef size_t rutz::fixed_block< T >::size_type

STL size type.

Definition at line 188 of file arrays.h.

template<class T>

typedef T rutz::fixed_block< T >::value_type

STL value type.

Definition at line 178 of file arrays.h.

---

Constructor & Destructor Documentation

template<class T>

rutz::fixed_block< T >::fixed_block

(

size_type

n

)

[inline]

Construct with a given size.

Definition at line 192 of file arrays.h.

template<class T>

rutz::fixed_block< T >::~fixed_block

(

)

[inline]

Destructor.

Definition at line 195 of file arrays.h.

template<class T>

template<class Itr >

rutz::fixed_block< T >::fixed_block	(	Itr	itr,
		Itr	end
	)			[inline]

Construct by copying from a given iterator range.

Definition at line 199 of file arrays.h.

---

Member Function Documentation

template<class T>

const_reference rutz::fixed_block< T >::at

(

size_type

n

)

const [inline]

Checked const array index (rutz::out_of_range thrown on bounds error).

Definition at line 225 of file arrays.h.

template<class T>

reference rutz::fixed_block< T >::at

(

size_type

n

)

[inline]

Checked non-const array index (rutz::out_of_range thrown on bounds error).

Definition at line 217 of file arrays.h.

template<class T>

const_iterator rutz::fixed_block< T >::begin

(

)

const [inline]

Const iterator to array start.

Definition at line 207 of file arrays.h.

template<class T>

iterator rutz::fixed_block< T >::begin

(

)

[inline]

Iterator to array start.

Definition at line 204 of file arrays.h.

template<class T>

const_iterator rutz::fixed_block< T >::end

(

)

const [inline]

Const iterator to array one-past-the-end.

Definition at line 208 of file arrays.h.

template<class T>

iterator rutz::fixed_block< T >::end

(

)

[inline]

Iterator to array one-past-the-end.

Definition at line 205 of file arrays.h.

template<class T>

bool rutz::fixed_block< T >::is_empty

(

)

const [inline]

Query whether size is zero.

Definition at line 239 of file arrays.h.

template<class T>

size_type rutz::fixed_block< T >::max_size

(

)

const [inline]

Maximum size of array type.

Definition at line 236 of file arrays.h.

template<class T>

const_reference rutz::fixed_block< T >::operator[]

(

size_type

n

)

const [inline]

Unchecked const array index.

Definition at line 214 of file arrays.h.

template<class T>

reference rutz::fixed_block< T >::operator[]

(

size_type

n

)

[inline]

Unchecked non-const array index.

Definition at line 211 of file arrays.h.

template<class T>

size_type rutz::fixed_block< T >::size

(

)

const [inline]

Size of array.

Definition at line 233 of file arrays.h.

template<class T>

void rutz::fixed_block< T >::swap

(

fixed_block< T > &

other

)

[inline]

Swap with another fixed_block.

This is fast since it only requires swapping the interal pointers to the dynamically-allocated arrays; no element-wise swap is needed.

Definition at line 245 of file arrays.h.

---

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

• src/rutz/arrays.h