Chaste  Release::2018.1
MathsCustomFunctions.hpp
Go to the documentation of this file.
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef MATHSCUSTOMFUNCTIONS_HPP_
37 #define MATHSCUSTOMFUNCTIONS_HPP_
38 
39 #include <cfloat>
40 
54 double SmallPow(double x, unsigned exponent);
55 
63 unsigned SmallPow(unsigned x, unsigned exponent);
64 
74 bool Divides(double smallerNumber, double largerNumber);
75 
83 unsigned CeilDivide(unsigned numerator, unsigned denominator);
84 
90 double Signum(double value);
91 
98 double SafeDivide(double numerator, double divisor);
99 
105 {
106 public:
114  static bool IsNearZero(double number, double tolerance);
115 
123  static bool WithinRelativeTolerance(double number1, double number2, double tolerance);
124 
133  static bool WithinAbsoluteTolerance(double number1, double number2, double tolerance);
134 
144  static bool WithinTolerance(double number1, double number2, double tolerance, bool toleranceIsAbsolute);
145 
156  static bool WithinAnyTolerance(double number1, double number2,
157  double relTol=DBL_EPSILON, double absTol=DBL_EPSILON,
158  bool printError=false);
159 
167  static double Difference(double number1, double number2, bool toleranceIsAbsolute);
168 };
169 
170 #endif /*MATHSCUSTOMFUNCTIONS_HPP_*/
static bool WithinAnyTolerance(double number1, double number2, double relTol=DBL_EPSILON, double absTol=DBL_EPSILON, bool printError=false)
double SmallPow(double x, unsigned exponent)
unsigned CeilDivide(unsigned numerator, unsigned denominator)
double SafeDivide(double numerator, double divisor)
bool Divides(double smallerNumber, double largerNumber)
double Signum(double value)
static double Difference(double number1, double number2, bool toleranceIsAbsolute)
static bool WithinRelativeTolerance(double number1, double number2, double tolerance)
static bool WithinAbsoluteTolerance(double number1, double number2, double tolerance)
static bool IsNearZero(double number, double tolerance)
static bool WithinTolerance(double number1, double number2, double tolerance, bool toleranceIsAbsolute)