Reference documentation for deal.II version 8.1.0
Public Member Functions | Protected Member Functions | List of all members
Table< 2, T > Class Template Reference

#include <table.h>

Inheritance diagram for Table< 2, T >:
[legend]

Public Member Functions

 Table ()
 
 Table (const unsigned int size1, const unsigned int size2)
 
void reinit (const unsigned int size1, const unsigned int size2, const bool fast=false)
 
::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)
 
std::vector< T >::const_reference operator() (const unsigned int i, const unsigned int j) const
 
std::vector< T >::reference operator() (const unsigned int i, const unsigned int j)
 
std::vector< T >::reference operator() (const TableIndices< 2 > &indices)
 
std::vector< T >::const_reference operator() (const TableIndices< 2 > &indices) const
 
unsigned int n_rows () const
 
unsigned int n_cols () const
 
- Public Member Functions inherited from TableBase< 2, T >
 TableBase ()
 
 TableBase (const TableIndices< N > &sizes)
 
 TableBase (const TableBase< N, T > &src)
 
 TableBase (const TableBase< N, T2 > &src)
 
 ~TableBase ()
 
TableBase< N, T > & operator= (const TableBase< N, T > &src)
 
TableBase< N, T > & operator= (const TableBase< N, T2 > &src)
 
bool operator== (const TableBase< N, T > &T2) const
 
void reset_values ()
 
void reinit (const TableIndices< N > &new_size, const bool fast=false)
 
unsigned int size (const unsigned int i) const
 
const TableIndices< N > & size () const
 
unsigned int n_elements () const
 
bool empty () const
 
void fill (const T2 *entries)
 
void fill (const T &value)
 
std::vector< T >::reference operator() (const TableIndices< N > &indices)
 
std::vector< T >::const_reference operator() (const TableIndices< N > &indices) const
 
void swap (TableBase< N, T > &v)
 
std::size_t memory_consumption () const
 
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Member Functions

std::vector< T >::reference el (const unsigned int i, const unsigned int j)
 
std::vector< T >::const_reference el (const unsigned int i, const unsigned int j) const
 
- Protected Member Functions inherited from TableBase< 2, T >
unsigned int position (const TableIndices< N > &indices) const
 
std::vector< T >::reference el (const TableIndices< N > &indices)
 
std::vector< T >::const_reference el (const TableIndices< N > &indices) const
 
std::vector< T >::const_pointer data () const DEAL_II_DEPRECATED
 

Additional Inherited Members

- Protected Attributes inherited from TableBase< 2, T >
std::vector< T > values
 
TableIndices< N > table_size
 

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

Definition at line 867 of file table.h.

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,
const bool  fast = false 
)

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 >
std::vector<T>::const_reference 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 >
std::vector<T>::reference 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 >
std::vector<T>::reference 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 >
std::vector<T>::const_reference 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 >
std::vector<T>::reference 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 >
std::vector<T>::const_reference 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: