Teuchos_ScalarTraitsDecl.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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef _TEUCHOS_SCALARTRAITS_DECL_HPP_
#define _TEUCHOS_SCALARTRAITS_DECL_HPP_

#include "Teuchos_ConfigDefs.hpp"


namespace Teuchos {


template <typename T>
struct UndefinedScalarTraits
{
  static inline T notDefined() { return T::this_type_is_missing_a_specialization(); }
};


/* This is the default structure used by ScalarTraits<T> to produce a compile time
  error when the specialization does not exist for type <tt>T</tt>.
*/


template <typename T>
struct ScalarTraits
{
  typedef T magnitudeType;
  typedef T halfPrecision;
  typedef T doublePrecision;
  static const bool isComplex = false;
  static const bool isOrdinal = false;
  static const bool isComparable = false;
  static const bool hasMachineParameters = false;
  static inline magnitudeType eps()   { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType sfmin() { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType base()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType prec()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType t()     { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType rnd()   { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType emin()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType rmin()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType emax()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType rmax()  { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType magnitude(T a) { return UndefinedScalarTraits<T>::notDefined(); }
  static inline T zero()                     { return UndefinedScalarTraits<T>::notDefined(); }
  static inline T one()                      { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType real(T a) { return UndefinedScalarTraits<T>::notDefined(); }
  static inline magnitudeType imag(T a) { return UndefinedScalarTraits<T>::notDefined(); }
  static inline T conjugate(T a) { return UndefinedScalarTraits<T>::notDefined(); }
  static inline T nan()                      { return UndefinedScalarTraits<T>::notDefined(); }
  static inline bool isnaninf(const T& x)     { return UndefinedScalarTraits<T>::notDefined(); }
  static inline void seedrandom(unsigned int s) { int i; T t = &i; }
  static inline T random()                   { return UndefinedScalarTraits<T>::notDefined(); }
  static inline std::string name()           { (void)UndefinedScalarTraits<T>::notDefined(); return 0; }
  static inline T squareroot(T x) { return UndefinedScalarTraits<T>::notDefined(); }
  static inline T pow(T x, T y) { return UndefinedScalarTraits<T>::notDefined(); }
};


} // Teuchos namespace


#endif // _TEUCHOS_SCALARTRAITS_DECL_HPP_