Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Static Public Member Functions | Static Public Attributes
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

static T zero ()
 Returns representation of zero for this ordinal type.
static T one ()
 Returns representation of one for this ordinal type.
static T max ()
 Returns a value designating the maximum value accessible by code using OrdinalTraits.
static T invalid ()
 Returns a value designating an invalid number. For signed types, this is typically negative one; for unsigned types, it is typically the largest value.
static std::string name ()
 Returns name of this ordinal type.

Static Public Attributes

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


Member Function Documentation

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

Returns representation of zero for this ordinal type.

Definition at line 87 of file Teuchos_OrdinalTraits.hpp.

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

Returns representation of one for this ordinal type.

Definition at line 90 of file Teuchos_OrdinalTraits.hpp.

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

Returns a value designating the maximum value accessible by code using OrdinalTraits.

For a signed ordinal, this will typically be the maximum positive value. However, for an unsigned ordinal, this will typically be one less than the maximum value, because the maximum value will typically be reserved for designating an invalid value.

Definition at line 96 of file Teuchos_OrdinalTraits.hpp.

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

Returns a value designating an invalid number. For signed types, this is typically negative one; for unsigned types, it is typically the largest value.

Definition at line 99 of file Teuchos_OrdinalTraits.hpp.

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

Returns name of this ordinal type.

Definition at line 102 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 84 of file Teuchos_OrdinalTraits.hpp.


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