Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
core
src
Teuchos_Utils.hpp
Go to the documentation of this file.
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
#ifndef TEUCHOS_UTILS_H
43
#define TEUCHOS_UTILS_H
44
48
49
#include "Teuchos_toString.hpp"
50
54
55
namespace
Teuchos
56
{
57
using
std::string;
58
59
class
TEUCHOSCORE_LIB_DLL_EXPORT
Utils
60
{
61
public
:
62
65
static
double
chop
(
const
double
& x);
66
69
static
double
getChopVal
() {
return
chopVal_;}
70
73
static
void
setChopVal
(
double
chopVal) {chopVal_ = chopVal;}
74
76
static
bool
isWhiteSpace
(
const
char
c )
77
{
return
( c==
' '
|| c ==
'\t'
|| c==
'\n'
); }
78
80
static
std::string trimWhiteSpace(
const
std::string& str );
81
83
static
std::string toString(
const
double
& x);
84
86
static
std::string toString(
const
int
& x);
87
89
static
std::string toString(
const
long
long
& x);
90
92
static
std::string toString(
const
unsigned
int
& x);
93
95
#ifdef M_PI
96
static
double
pi() {
return
M_PI;}
97
#else
98
static
double
pi
() {
return
3.14159265358979323846;}
99
#endif
100
102
static
std::string getParallelExtension(
103
int
procRank = -1
104
,
int
numProcs = -1
105
);
106
107
private
:
108
static
double
chopVal_;
109
};
110
111
112
}
// end namespace Teuchos
113
114
#endif
115
116
Teuchos::Utils
This class provides some basic std::string and floating-point utilities for Teuchos.
Definition
Teuchos_Utils.hpp:60
Teuchos::Utils::setChopVal
static void setChopVal(double chopVal)
Set the chopping value, below which numbers are considered to be zero.
Definition
Teuchos_Utils.hpp:73
Teuchos::Utils::getChopVal
static double getChopVal()
Get the chopping value, below which numbers are considered to be zero.
Definition
Teuchos_Utils.hpp:69
Teuchos::Utils::chop
static double chop(const double &x)
Set a number to zero if it is less than getChopVal().
Definition
Teuchos_Utils.cpp:49
Teuchos::Utils::pi
static double pi()
pi.
Definition
Teuchos_Utils.hpp:98
Teuchos::Utils::isWhiteSpace
static bool isWhiteSpace(const char c)
Determine if a char is whitespace or not.
Definition
Teuchos_Utils.hpp:76
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Generated by
1.17.0