Table< 2, T > Class Template Reference
[Data storage primitives]

Inheritance diagram for Table< 2, T >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 Table ()
 Table (const unsigned int size1, const unsigned int size2)
void reinit (const unsigned int size1, const unsigned int size2)
internal::TableBaseAccessors::Accessor
< 2, T, true, 1 > 
operator[] (const unsigned int i) const
internal::TableBaseAccessors::Accessor
< 2, T, false, 1 > 
operator[] (const unsigned int i)
const T & operator() (const unsigned int i, const unsigned int j) const
T & operator() (const unsigned int i, const unsigned int j)
T & operator() (const TableIndices< 2 > &indices)
const T & operator() (const TableIndices< 2 > &indices) const
unsigned int n_rows () const
unsigned int n_cols () const

Protected Member Functions

T & el (const unsigned int i, const unsigned int j)
const T & el (const unsigned int i, const unsigned int j) const


Detailed Description

template<typename T>
class Table< 2, T >

A class representing a two-dimensional table, i.e. a matrix of objects (not necessarily only numbers).

For the rationale of this class, and a description of the interface, see the base class. Since this serves as the base class of the full matrix classes in this library, and to keep a minimal compatibility with a predecessor class (vector2d), some additional functions are provided.

Author:
Wolfgang Bangerth, 2002

Constructor & Destructor Documentation

template<typename T >
Table< 2, T >::Table (  ) 

Default constructor. Set all dimensions to zero.

template<typename T >
Table< 2, T >::Table ( const unsigned int  size1,
const unsigned int  size2 
)

Constructor. Pass down the given dimensions to the base class.


Member Function Documentation

template<typename T >
void Table< 2, T >::reinit ( const unsigned int  size1,
const unsigned int  size2 
)

Reinitialize the object. This function is mostly here for compatibility with the earlier vector2d class. Passes down to the base class by converting the arguments to the data type requested by the base class.

template<typename T >
internal::TableBaseAccessors::Accessor<2,T,true,1> Table< 2, T >::operator[] ( const unsigned int  i  )  const

Access operator. Generate an object that accesses the requested row of this two-dimensional table. Range checks are performed.

This version of the function only allows read access.

template<typename T >
internal::TableBaseAccessors::Accessor<2,T,false,1> Table< 2, T >::operator[] ( const unsigned int  i  ) 

Access operator. Generate an object that accesses the requested row of this two-dimensional table. Range checks are performed.

This version of the function allows read-write access.

template<typename T >
const T& Table< 2, T >::operator() ( const unsigned int  i,
const unsigned int  j 
) const

Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.

This version of the function only allows read access.

template<typename T >
T& Table< 2, T >::operator() ( const unsigned int  i,
const unsigned int  j 
)

Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.

This version of the function allows read-write access.

template<typename T >
T& Table< 2, T >::operator() ( const TableIndices< 2 > &  indices  ) 

Make the corresponding operator() from the TableBase base class available also in this class.

template<typename T >
const T& Table< 2, T >::operator() ( const TableIndices< 2 > &  indices  )  const

Make the corresponding operator() from the TableBase base class available also in this class.

template<typename T >
unsigned int Table< 2, T >::n_rows (  )  const

Number of rows. This function really makes only sense since we have a two-dimensional object here.

template<typename T >
unsigned int Table< 2, T >::n_cols (  )  const

Number of columns. This function really makes only sense since we have a two-dimensional object here.

template<typename T >
T& Table< 2, T >::el ( const unsigned int  i,
const unsigned int  j 
) [protected]

Return a read-write reference to the element (i,j).

This function does no bounds checking and is only to be used internally and in functions already checked.

These functions are mainly here for compatibility with a former implementation of these table classes for 2d arrays, then called vector2d.

template<typename T >
const T& Table< 2, T >::el ( const unsigned int  i,
const unsigned int  j 
) const [protected]

Return the value of the element (i,j) as a read-only reference.

This function does no bounds checking and is only to be used internally and in functions already checked.

We return the requested value as a constant reference rather than by value since this object may hold data types that may be large, and we don't know here whether copying is expensive or not.

These functions are mainly here for compatibility with a former implementation of these table classes for 2d arrays, then called vector2d.


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

deal.II documentation generated on Sat Aug 15 16:52:25 2009 by doxygen 1.5.9