Teuchos::Tuple< T, N > Class Template Reference
[Teuchos Memory Management Utilities]

Statically sized simple array (tuple) class. More...

#include <Teuchos_Tuple.hpp>

Inheritance diagram for Teuchos::Tuple< T, N >:

Teuchos::ArrayView< T > List of all members.

Public Member Functions

 Tuple ()
 Default construct raw storage.
 Tuple (const Tuple< T, N > &t)
 Copy constructor.
Tuple< T, N > & operator= (const Tuple< T, N > &t)
 Copy constructor.

Related Functions

(Note that these are not member functions.)

Tuple< T, 1 > tuple (const T &a)
 Create a Tuple<T,1>.
Tuple< T, 2 > tuple (const T &a, const T &b)
 Create a Tuple<T,2>.
Tuple< T, 3 > tuple (const T &a, const T &b, const T &c)
 Create a Tuple<T,3>.
Tuple< T, 4 > tuple (const T &a, const T &b, const T &c, const T &d)
 Create a Tuple<T,4>.
Tuple< T, 5 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e)
 Create a Tuple<T,5>.
Tuple< T, 6 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e, const T &f)
 Create a Tuple<T,6>.
Tuple< T, 7 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e, const T &f, const T &g)
 Create a Tuple<T,7>.
Tuple< T, 8 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e, const T &f, const T &g, const T &h)
 Create a Tuple<T,8>.
Tuple< T, 9 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e, const T &f, const T &g, const T &h, const T &i)
 Create a Tuple<T,9>.
Tuple< T, 10 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e, const T &f, const T &g, const T &h, const T &i, const T &j)
 Create a Tuple<T,10>.

Detailed Description

template<typename T, int N>
class Teuchos::Tuple< T, N >

Statically sized simple array (tuple) class.

ToDo: Finish documentation!

Design Discussion

This class derives from ArrayView and therefore inherits all of the features line element access and iterators along with full runtime checking. It does so at the expense of a little extra data (an extra pointer and an extra integer). However, this overhead will be small for any reasonable size of N.

Definition at line 54 of file Teuchos_Tuple.hpp.


Constructor & Destructor Documentation

template<typename T, int N>
Teuchos::Tuple< T, N >::Tuple (  )  [inline]

Default construct raw storage.

Definition at line 167 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Teuchos::Tuple< T, N >::Tuple ( const Tuple< T, N > &  t  ) 

Copy constructor.

Definition at line 173 of file Teuchos_Tuple.hpp.


Member Function Documentation

template<typename T, int N>
Tuple< T, N > & Teuchos::Tuple< T, N >::operator= ( const Tuple< T, N > &  t  ) 

Copy constructor.

Definition at line 184 of file Teuchos_Tuple.hpp.


Friends And Related Function Documentation

template<typename T, int N>
Tuple< T, 1 > tuple ( const T &  a  )  [related]

Create a Tuple<T,1>.

Definition at line 204 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 2 > tuple ( const T &  a,
const T &  b 
) [related]

Create a Tuple<T,2>.

Definition at line 214 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 3 > tuple ( const T &  a,
const T &  b,
const T &  c 
) [related]

Create a Tuple<T,3>.

Definition at line 225 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 4 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d 
) [related]

Create a Tuple<T,4>.

Definition at line 237 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 5 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e 
) [related]

Create a Tuple<T,5>.

Definition at line 250 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 6 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e,
const T &  f 
) [related]

Create a Tuple<T,6>.

Definition at line 264 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 7 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e,
const T &  f,
const T &  g 
) [related]

Create a Tuple<T,7>.

Definition at line 280 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 8 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e,
const T &  f,
const T &  g,
const T &  h 
) [related]

Create a Tuple<T,8>.

Definition at line 297 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 9 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e,
const T &  f,
const T &  g,
const T &  h,
const T &  i 
) [related]

Create a Tuple<T,9>.

Definition at line 315 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 10 > tuple ( const T &  a,
const T &  b,
const T &  c,
const T &  d,
const T &  e,
const T &  f,
const T &  g,
const T &  h,
const T &  i,
const T &  j 
) [related]

Create a Tuple<T,10>.

Definition at line 334 of file Teuchos_Tuple.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:40:34 2010 for Teuchos - Trilinos Tools Package by  doxygen 1.4.7