Teuchos_OrdinalTraits.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

// Kris
// 07.08.03 -- Move into Teuchos package/namespace

#ifndef _TEUCHOS_ORDINALTRAITS_HPP_
#define _TEUCHOS_ORDINALTRAITS_HPP_

namespace Teuchos {
  
  template<class T>
  struct OrdinalTraits {

    static inline int unsupportedType() {
#ifndef TEUCHOS_NO_ERROR_REPORTS
      cerr << endl << "Teuchos::OrdinalTraits: unsupported ordinal type." << endl;
#endif
      return(-1);
    }

    static inline bool haveMachineParameters() {return(false);}; 
    
    static inline T zero()                     {throw(unsupportedType());};

    static inline T one()                      {throw(unsupportedType());};

    static inline const char* name()           {throw(unsupportedType());};
  };
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS

  template<>
  struct OrdinalTraits<int> {

    static inline bool haveMachineParameters() {return(false);}; // Allows testing to see if ordinal traits machine parameters defined 
    static inline int zero()                   {return(0);};
    static inline int one()                    {return(1);};
    static inline const char* name()           {return("int");};
  };

  template<>
  struct OrdinalTraits<long int> {

    static inline bool haveMachineParameters() {return(false);}; // Allows testing to see if ordinal traits machine parameters defined 
    static inline long int zero()                   {return((long int)0);};
    static inline long int one()                    {return((long int)1);};
    static inline const char* name()           {return("long int");};
  };

#endif

} // namespace Teuchos

#endif // _TEUCHOS_ORDINALTRAITS_HPP_

---