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>.
Tuple< T, 11 > 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, const T &k)
 Create a Tuple<T,11>.
Tuple< T, 12 > 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, const T &k, const T &l)
 Create a Tuple<T,12>.
Tuple< T, 13 > 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, const T &k, const T &l, const T &m)
 Create a Tuple<T,13>.
Tuple< T, 14 > 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, const T &k, const T &l, const T &m, const T &n)
 Create a Tuple<T,14>.
Tuple< T, 15 > 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, const T &k, const T &l, const T &m, const T &n, const T &o)
 Create a Tuple<T,15>.

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 216 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 224 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 236 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 256 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 266 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 277 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 289 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 302 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 316 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 332 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 349 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 367 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 386 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 11 > 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,
const T &  k 
) [related]

Create a Tuple<T,11>.

Definition at line 406 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 12 > 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,
const T &  k,
const T &  l 
) [related]

Create a Tuple<T,12>.

Definition at line 426 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 13 > 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,
const T &  k,
const T &  l,
const T &  m 
) [related]

Create a Tuple<T,13>.

Definition at line 448 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 14 > 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,
const T &  k,
const T &  l,
const T &  m,
const T &  n 
) [related]

Create a Tuple<T,14>.

Definition at line 472 of file Teuchos_Tuple.hpp.

template<typename T, int N>
Tuple< T, 15 > 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,
const T &  k,
const T &  l,
const T &  m,
const T &  n,
const T &  o 
) [related]

Create a Tuple<T,15>.

Definition at line 497 of file Teuchos_Tuple.hpp.


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