/usr/include/trilinos/Teuchos_MatrixMarket_SetScientific.hpp is in libtrilinos-teuchos-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | // @HEADER
// ***********************************************************************
//
// Tpetra: Templated Linear Algebra Services Package
// Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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_MatrixMarket_SetScientific_hpp
#define __Teuchos_MatrixMarket_SetScientific_hpp
#include <Teuchos_ConfigDefs.hpp>
#include <Teuchos_as.hpp>
#include <Teuchos_ScalarTraits.hpp>
#include <string>
namespace Teuchos {
namespace MatrixMarket {
namespace details {
/// \class SetScientificImpl
/// \brief Implementation of SetScientific.
///
/// This class is an implementation detail of SetScientific.
/// Users should use SetScientific, not this class.
///
/// \tparam Scalar A type for which
/// Teuchos::ScalarTraits<Scalar> has a specialization.
/// \tparam isFloatingPoint Whether Scalar is a floating-point
/// type (either real or complex).
template<class Scalar, const bool isFloatingPoint>
class SetScientificImpl {
public:
//! The Scalar type with which SetScientific was specialized.
typedef Scalar scalar_type;
/// Constructor.
///
/// \param out [in/out] Output stream to which to apply the
/// scientific notation flags.
SetScientificImpl (std::ostream& out);
/// Destructor.
///
/// The destructor sets the output stream's flags back to
/// their original state, that is, the state before the
/// constructor of this object was called.
~SetScientificImpl ();
};
/// Partial specialization of SetScientificImpl for floating-point types.
///
/// This class currently requires that std::log10() take
/// arguments of type Scalar. This may be relaxed in the future
/// if Teuchos::ScalarTraits gets its own log10() method.
template<class Scalar>
class SetScientificImpl<Scalar, true> {
public:
typedef Scalar scalar_type;
SetScientificImpl (std::ostream& out) :
out_ (out), originalFlags_ (out.flags())
{
typedef Teuchos::ScalarTraits<scalar_type> STS;
typedef typename STS::magnitudeType magnitude_type;
typedef Teuchos::ScalarTraits<magnitude_type> STM;
// Print floating-point values in scientific notation.
out << std::scientific;
// We're writing decimal digits, so compute the number of
// digits we need to get reasonable accuracy when reading
// values back in.
//
// There is actually an algorithm, due to Guy Steele (yes,
// Java's Guy Steele) et al., for idempotent printing of
// finite-length floating-point values. We should actually
// implement that algorithm, but I don't have time for that
// now. Currently, I just print no more than (one decimal
// digit more than (the number of decimal digits justified
// by the precision of magnitude_type)).
//
// We need to use STM's log10() rather than (say) std::log10
// here, because STM::base() returns a magnitude_type, not
// one of C++'s standard integer types.
const magnitude_type numDecDigits = STM::t() * STM::log10 (STM::base());
// Round and add one. The cast to int should not overflow
// unless STM::t() is _extremely_ large, so we don't need to
// check for that case here.
const magnitude_type one = STM::one();
const magnitude_type two = one + one;
// Cast from magnitude_type to int, since std::ostream's
// precision() method expects an int input.
const int prec = 1 + Teuchos::as<int> (magnitude_type((two*numDecDigits + one) / two));
// Set the number of (decimal) digits after the decimal
// point to print.
out.precision (prec);
}
~SetScientificImpl () {
out_.flags (originalFlags_);
}
private:
//! The output stream to which to apply flags.
std::ostream& out_;
//! The output stream's original flags.
std::ios_base::fmtflags originalFlags_;
};
//! Partial specialization of SetScientificImpl for non-floating-point types.
template<class Scalar>
class SetScientificImpl<Scalar, false> {
public:
typedef Scalar scalar_type;
SetScientificImpl (std::ostream&) {}
~SetScientificImpl () {}
};
/// \class SetScientific
/// \brief Temporarily make an output stream use scientific
/// notation with sufficient precision.
///
/// On construction, apply the necessary flags to the given
/// output stream so that floating-point numbers are written in
/// scientific notation with precision (dependent on the Scalar
/// type) sufficient to ensure that they can be read in with the
/// same value. On destruction, restore the original
/// (pre-construction) flags to the output stream.
///
/// This makes SetScientific good for scope-protected alteration
/// of the output stream's flags; no matter how the scope exits
/// (normally or by a thrown exception), the original flags will
/// be restored. Hence, "temporarily" (or even "politely"): we
/// restore the original flags on scope exit.
///
/// \tparam Scalar A floating-point type, either real or
/// complex, for which Teuchos::ScalarTraits<Scalar> has a
/// specialization.
template<class Scalar>
class SetScientific :
public SetScientificImpl<Scalar, ! Teuchos::ScalarTraits<Scalar>::isOrdinal> {
private:
//! Parent class of this class.
typedef SetScientificImpl<Scalar, ! Teuchos::ScalarTraits<Scalar>::isOrdinal> base_type;
public:
//! The Scalar type with which SetScientific was specialized.
typedef Scalar scalar_type;
/// Constructor.
///
/// \param out [in/out] Output stream to which to apply the
/// scientific notation flags.
SetScientific (std::ostream& out) : base_type (out) {}
/// Destructor.
///
/// The destructor sets the output stream's flags back to
/// their original state, that is, the state before the
/// constructor of this object was called.
~SetScientific () {
// Parent class' destructor will be called automatically.
}
};
// // Specialization for Scalar=int. Specializations for built-in
// // integer types let Tpetra::MatrixMarket::Reader or
// // Tpetra::MatrixMarket::Writer work with a Tpetra::CrsMatrix
// // whose Scalar template parameter is a built-in integer type.
// // These specializations are trivial because there are no
// // decimal digits to print.
// template<>
// class SetScientific<int> {
// public:
// typedef int scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// // Specialization for Scalar=unsigned int.
// template<>
// class SetScientific<unsigned int> {
// public:
// typedef unsigned int scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// // Specialization for Scalar=long.
// template<>
// class SetScientific<long> {
// public:
// typedef long scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// // Specialization for Scalar=unsigned long.
// template<>
// class SetScientific<unsigned long> {
// public:
// typedef unsigned long scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// #ifdef HAVE_TEUCHOS_LONG_LONG_INT
// // Specialization for Scalar=long long.
// template<>
// class SetScientific<long long> {
// public:
// typedef long long scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// // Specialization for Scalar=unsigned long long.
// template<>
// class SetScientific<unsigned long long> {
// public:
// typedef unsigned long long scalar_type;
// SetScientific (std::ostream& out) {}
// ~SetScientific () {}
// };
// #endif // HAVE_TEUCHOS_LONG_LONG_INT
} // namespace details
} // namespace MatrixMarket
} // namespace Teuchos
#endif // __Teuchos_MatrixMarket_SetScientific_hpp
|