Teuchos_ScalarTraitsDecl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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;
  typedef T coordinateType;
  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(); }
  static inline T pi() { return UndefinedScalarTraits<T>::notDefined();}
};


} // Teuchos namespace


#endif // _TEUCHOS_SCALARTRAITS_DECL_HPP_