afl::Element< D > Class Template Reference

#include <element.h>

List of all members.

Public Member Functions

 Element ()
 Element (const Element< D > &toCopy)
Element< D > & operator= (const Element< D > &toCopy)
 Element (size_t u1, size_t u2)
 Element (size_t u1, size_t u2, size_t u3)
 Element (size_t u1, size_t u2, size_t u3, size_t u4)
 Element (size_t u1, size_t u2, size_t u3, size_t u4, size_t u5)
size_t & operator[] (size_t i)
size_t operator[] (size_t i) const


Detailed Description

template<size_t D>
class afl::Element< D >

a data structure that holds indices into a xs property for points that define elements. Normally these elements are triangulated elements. The number of indices is one more than the dimension of the element so a 1D element should have 2 indices.
Parameters:
D the dimension of the element


Constructor & Destructor Documentation

template<size_t D>
afl::Element< D >::Element  )  [inline]
 

constructs a blank element

template<size_t D>
afl::Element< D >::Element const Element< D > &  toCopy  )  [inline]
 

copy constructor

Parameters:
toCopy the element to Copy

template<size_t D>
afl::Element< D >::Element size_t  u1,
size_t  u2
 

constructs a 1D element

Parameters:
u1 the index of the element's u1.
u2 the index of the element's u2.
Exceptions:
ddf::InvalidArgumentException if this constructor is used to construct an element that is not 1D

template<size_t D>
afl::Element< D >::Element size_t  u1,
size_t  u2,
size_t  u3
 

constructs a 2D element

Parameters:
u1 the index of the element's u1.
u2 the index of the element's u2.
u3 the index of the element's u3.
Exceptions:
ddf::InvalidArgumentException if this constructor is used to construct an element that is not 2D

template<size_t D>
afl::Element< D >::Element size_t  u1,
size_t  u2,
size_t  u3,
size_t  u4
 

constructs a 3D element

Parameters:
u1 the index of the element's u1.
u2 the index of the element's u2.
u3 the index of the element's u3.
u4 the index of the element's u4.
Exceptions:
ddf::InvalidArgumentException if this constructor is used to construct an element that is not 3D

template<size_t D>
afl::Element< D >::Element size_t  u1,
size_t  u2,
size_t  u3,
size_t  u4,
size_t  u5
 

constructs a 4D element

Parameters:
u1 the index of the element's u1.
u2 the index of the element's u2.
u3 the index of the element's u3.
u4 the index of the element's u4.
u5 the index of the element's u5.
Exceptions:
ddf::InvalidArgumentException if this constructor is used to construct an element that is not 4D


Member Function Documentation

template<size_t D>
Element<D>& afl::Element< D >::operator= const Element< D > &  toCopy  )  [inline]
 

assignment operator

Parameters:
toCopy the element to replicate
Returns:
a reference to this

template<size_t D>
size_t afl::Element< D >::operator[] size_t  i  )  const [inline]
 

indexed and checked access to the element

Parameters:
i the index
Returns:
the index of the vertex of the element
Exceptions:
ddf::OutOfBoundsException if i > than the dimension of the element

template<size_t D>
size_t& afl::Element< D >::operator[] size_t  i  )  [inline]
 

indexed and checked access to the element

Parameters:
i the index
Returns:
the index of the vertex of the element
Exceptions:
ddf::OutOfBoundsException if i > than the dimension of the element


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 07:17:51 2006 for afl by  doxygen 1.4.6