Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

Vector< T > Class Template Reference

one dimensional dynamic array More...

#include <Vector.H>

Inheritance diagram for Vector< T >:

Inheritance graph
[legend]
Collaboration diagram for Vector< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Vector ()
virtual ~Vector ()
 Vector (const Vector< T > &invec)
 Vector (const std::vector< T > &invec)
Vector< T > & operator= (const std::vector< T > &invec)
Vector< T > & operator= (const Vector< T > &invec)
Vector< T > & assign (const T &inval)
 assign a scalar to every element of the vector

 Vector (unsigned int isize)
void clear ()
size_t size () const
 Vector (unsigned int isize, const T &value)
T & operator[] (unsigned int n)
const T & operator[] (unsigned int n) const
void swap (Vector< T > &other)
void push_back (const T &in)
void append (const Vector< T > &invec)
void resize (unsigned int isize)
void reserve (size_t isize)
size_t capacity () const
void resize (unsigned int isize, const T &value)
void sort ()

Detailed Description

template<class T>
class Vector< T >

one dimensional dynamic array

Vector is a resizable one-dimensional array with constant-time random access and range checking. The template type T must have a default constructor, a copy constructor, and an assignment operator.

Vector<T> is publically derived from std::vector<T>. Read the friendly STL manual.


Constructor & Destructor Documentation

template<class T>
Vector< T >::Vector  )  [inline]
 

Default constructor. Creates a Vector of zero length with null data.

template<class T>
virtual Vector< T >::~Vector  )  [inline, virtual]
 

Destructor.

template<class T>
Vector< T >::Vector const Vector< T > &  invec  )  [inline]
 

Copy constructor.

template<class T>
Vector< T >::Vector const std::vector< T > &  invec  )  [inline]
 

conversion constructor

template<class T>
Vector< T >::Vector unsigned int  isize  )  [inline]
 

Constructs a Vector with given number of elements.\

{ Arguments:} \ size (not modified): number of elements of Vector to construct.\ { This:} \ -------The object is modified----------

template<class T>
Vector< T >::Vector unsigned int  isize,
const T &  value
[inline]
 

Constructs a Vector with given number of elements and constant value.\

{ Arguments:} \ size (not modified): number of elements of Vector to construct.\ value (not modified): value to set every element to.\ { This:} \ -------The object is modified----------


Member Function Documentation

template<class T>
void Vector< T >::append const Vector< T > &  invec  )  [inline]
 

Modifies this Vector by appending the elements of the argument Vector. The new Vector will have a size of this->size() + invec.size() (where this Vector is considered before the append is performed). The first element of invec will have index this->size(), the second element will have index this->size()+1, etc.\

{ Arguments:} \ invec (not modified): Vector whose elements to append to this Vector.\ { This:} \ -------The object is modified----------

template<class T>
Vector<T>& Vector< T >::assign const T &  inval  )  [inline]
 

assign a scalar to every element of the vector

[NOTE: cant use operator=() for this because it would be ambiguous with the (int) constructor for number T types.]

template<class T>
size_t Vector< T >::capacity  )  const [inline]
 

template<class T>
void Vector< T >::clear  )  [inline]
 

template<class T>
Vector<T>& Vector< T >::operator= const Vector< T > &  invec  )  [inline]
 

template<class T>
Vector<T>& Vector< T >::operator= const std::vector< T > &  invec  )  [inline]
 

template<class T>
const T& Vector< T >::operator[] unsigned int  n  )  const [inline]
 

Returns a constant reference to the given element in this Vector.\

{ Arguments: } \ n (not modified) index of desired element.\ { Returns:} \ constant reference to value in Vector at index n.\ { This:} \ This object is not modified.

template<class T>
T& Vector< T >::operator[] unsigned int  n  )  [inline]
 

Returns a modifiable lvalue reference to the value of the given element in this Vector. It is an error if n < 0 or n >= this->size(). \

{ Arguments: } \ n (not modified) index of desired element.\ { Returns:} \ modifiable reference to value in Vector at index n.\ { This:} \ ----- This object is modified if the returned reference is assigned a new value -----

template<class T>
void Vector< T >::push_back const T &  in  )  [inline]
 

template<class T>
void Vector< T >::reserve size_t  isize  )  [inline]
 

template<class T>
void Vector< T >::resize unsigned int  isize,
const T &  value
[inline]
 

template<class T>
void Vector< T >::resize unsigned int  isize  )  [inline]
 

template<class T>
size_t Vector< T >::size  )  const [inline]
 

size function. returns current size of Vector

template<class T>
void Vector< T >::sort  )  [inline]
 

template<class T>
void Vector< T >::swap Vector< T > &  other  )  [inline]
 


The documentation for this class was generated from the following file:
Generated on Wed Jun 2 13:59:09 2004 for Chombo&INSwithParticles by doxygen 1.3.2