Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Attributes | Related Functions
Teuchos::Tuple< T, N > Class Template Reference

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

#include <Teuchos_Tuple.hpp>

Inheritance diagram for Teuchos::Tuple< T, N >:
Inheritance graph
[legend]

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.

Private Attributes

array_ [N]

Related Functions

(Note that these are not member functions.)

template<typename T >
Tuple< T, 1 > tuple (const T &a)
 Create a Tuple<T,1>.
template<typename T >
Tuple< T, 2 > tuple (const T &a, const T &b)
 Create a Tuple<T,2>.
template<typename T >
Tuple< T, 3 > tuple (const T &a, const T &b, const T &c)
 Create a Tuple<T,3>.
template<typename T >
Tuple< T, 4 > tuple (const T &a, const T &b, const T &c, const T &d)
 Create a Tuple<T,4>.
template<typename T >
Tuple< T, 5 > tuple (const T &a, const T &b, const T &c, const T &d, const T &e)
 Create a Tuple<T,5>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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>.
template<typename T >
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 >
Tuple< T, 1 > tuple ( const T &  a) [related]

Create a Tuple<T,1>.

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

Create a Tuple<T,2>.

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

Create a Tuple<T,3>.

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

Create a Tuple<T,4>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.

template<typename T >
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>.


Member Data Documentation

template<typename T, int N>
T Teuchos::Tuple< T, N >::array_[N] [private]

Definition at line 71 of file Teuchos_Tuple.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines