Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_ScalarTraits.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "Teuchos_ScalarTraits.hpp"
43 #include "Teuchos_Assert.hpp"
44 
45 // Define this to throw exceptions when any Teuchos::ScalarTraits function
46 // encounters a NaN or an Inf.
47 //#define TEUCHOS_SCALAR_TRAITS_THROW_NAN_INF_ERR
48 
49 #ifdef HAVE_TEUCHOSCORE_QUADMATH
50 namespace std {
51 
52 std::ostream&
53 operator<< (std::ostream& out, const __float128& x)
54 {
55  const size_t bufSize = 128;
56  char buf[128];
57 
58  const int numCharPrinted = quadmath_snprintf (buf, bufSize, "%.30Qe", x);
59  if (static_cast<size_t> (numCharPrinted) >= bufSize) {
60  std::ostringstream os;
61  os << "Failed to print __float128 value: buffer has " << bufSize
62  << " characters, but quadmath_snprintf wanted " << numCharPrinted
63  << " characters!";
64  throw std::runtime_error (os.str ());
65  }
66  out << buf;
67  return out;
68 }
69 
70 istream&
71 operator>> (std::istream& in, __float128& x)
72 {
73  std::string tmpStr;
74  in >> tmpStr;
75  // FIXME (mfh 10 Sep 2015) I don't think this routine does any error
76  // checking.
77  x = strtoflt128 (tmpStr.c_str (), NULL);
78  return in;
79 }
80 
81 } // namespace std
82 #endif // HAVE_TEUCHOSCORE_QUADMATH
83 
84 namespace {
85 
86 // These functions exist to trick the compiler into not returning a warning
87 // message for 0.0/0.0 or refusing to compile the code. If a compiler gets
88 // too smart, we can put these definitions into a different *.cpp file such
89 // that most compilers would not be able to know at compile-time if a NaN or
90 // an Inf was being created.
91 
92 float returnFloatZero() { return 0.0; }
93 
94 double returnDoubleZero() { return 0.0; }
95 
96 } // namespace
97 
98 
99 void Teuchos::throwScalarTraitsNanInfError( const std::string &errMsg )
100 {
101 #ifdef TEUCHOS_SCALAR_TRAITS_THROW_NAN_INF_ERR
102  TEUCHOS_TEST_FOR_EXCEPTION( true, std::runtime_error, errMsg );
103 #endif
104 }
105 
106 #ifdef HAVE_TEUCHOS_GNU_MP
107 gmp_randclass Teuchos::gmp_rng ( gmp_randinit_default );
108 #endif
109 
110 #ifdef HAVE_TEUCHOS_QD
111 bool Teuchos::operator&&(const dd_real &a, const dd_real &b) {
112  return !a.is_zero() && !b.is_zero();
113 }
114 bool Teuchos::operator&&(const qd_real &a, const qd_real &b) {
115  return !a.is_zero() && !b.is_zero();
116 }
117 #endif
118 
119 #ifndef __sun
120 // This is an intentional computation of NaN.
121 namespace Teuchos {
122 const float flt_nan = +returnFloatZero()/returnFloatZero();
123 const double dbl_nan = +returnDoubleZero()/returnDoubleZero();
124 }
125 #endif
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.
Defines basic traits for the scalar field type.