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
int	unsupportedType ()
	Aborting function to restrict non-supported implementations of OrdinalTraits.
bool	haveMachineParameters ()
	Allows testing to see if ordinal traits machine parameters are defined.
T	zero ()
	Returns representation of zero for this ordinal type.
T	one ()
	Returns representation of one for this ordinal type.
const char *	name ()
	Returns name of this ordinal type.

---

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 55 of file Teuchos_OrdinalTraits.hpp.

---

Member Function Documentation

template<class T> int Teuchos::OrdinalTraits< T >::unsupportedType (   )  [inline, static]

Aborting function to restrict non-supported implementations of OrdinalTraits. Definition at line 58 of file Teuchos_OrdinalTraits.hpp.

template<class T> bool Teuchos::OrdinalTraits< T >::haveMachineParameters (   )  [inline, static]

Allows testing to see if ordinal traits machine parameters are defined. Definition at line 66 of file Teuchos_OrdinalTraits.hpp.

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

Returns representation of zero for this ordinal type. Definition at line 69 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 72 of file Teuchos_OrdinalTraits.hpp.

template<class T> const char* Teuchos::OrdinalTraits< T >::name (   )  [inline, static]

Returns name of this ordinal type. Definition at line 75 of file Teuchos_OrdinalTraits.hpp.

---

The documentation for this struct was generated from the following file:

• Teuchos_OrdinalTraits.hpp

---