Teuchos::OrdinalTraits< T > Struct Template Reference

This structure defines some basic traits for the ordinal field type. More...

#include <Teuchos_OrdinalTraits.hpp>

List of all members.

Static Public Member Functions

zero ()
 Returns representation of zero for this ordinal type.
one ()
 Returns representation of one for this ordinal type.
std::string name ()
 Returns name of this ordinal type.

Static Public Attributes

const bool hasMachineParameters = false
 Allows testing to see if ordinal traits machine parameters are defined.


Detailed Description

template<class T>
struct Teuchos::OrdinalTraits< T >

This structure defines some basic traits for the ordinal field type.

Ordinal traits are an essential part of templated codes. This structure offers the basic traits of the templated ordinal type, like defining zero and one.

For the general type, or default implementation, an aborting function is defined which should restrict implementations from using ordinal traits other than the defined specializations.

Note:
The defined specializations for OrdinalTraits are: int and long int.

Definition at line 67 of file Teuchos_OrdinalTraits.hpp.


Member Function Documentation

template<class T>
T Teuchos::OrdinalTraits< T >::zero  )  [inline, static]
 

Returns representation of zero for this ordinal type.

Definition at line 73 of file Teuchos_OrdinalTraits.hpp.

template<class T>
T Teuchos::OrdinalTraits< T >::one  )  [inline, static]
 

Returns representation of one for this ordinal type.

Definition at line 76 of file Teuchos_OrdinalTraits.hpp.

template<class T>
std::string Teuchos::OrdinalTraits< T >::name  )  [inline, static]
 

Returns name of this ordinal type.

Definition at line 79 of file Teuchos_OrdinalTraits.hpp.


Member Data Documentation

template<class T>
const bool Teuchos::OrdinalTraits< T >::hasMachineParameters = false [static]
 

Allows testing to see if ordinal traits machine parameters are defined.

Definition at line 70 of file Teuchos_OrdinalTraits.hpp.


The documentation for this struct was generated from the following file:
Generated on Thu Sep 18 12:39:12 2008 for Teuchos - Trilinos Tools Package by doxygen 1.3.9.1