Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
MathsCustomFunctions.hpp
Go to the documentation of this file.
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF 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#include <cstddef>
41
55double SmallPow(double x, unsigned exponent);
56
64unsigned SmallPow(unsigned x, unsigned exponent);
65
75bool Divides(double smallerNumber, double largerNumber);
76
84unsigned CeilDivide(unsigned numerator, unsigned denominator);
85
91double Signum(double value);
92
99double SafeDivide(double numerator, double divisor);
100
113unsigned AdvanceMod(unsigned index, int increment, std::size_t range) noexcept;
114
124unsigned SmallDifferenceMod(unsigned idxA, unsigned idxB, std::size_t range) noexcept;
125
131{
132public:
140 static bool IsNearZero(double number, double tolerance);
141
149 static bool WithinRelativeTolerance(double number1, double number2, double tolerance);
150
159 static bool WithinAbsoluteTolerance(double number1, double number2, double tolerance);
160
170 static bool WithinTolerance(double number1, double number2, double tolerance, bool toleranceIsAbsolute);
171
182 static bool WithinAnyTolerance(double number1, double number2,
183 double relTol=DBL_EPSILON, double absTol=DBL_EPSILON,
184 bool printError=false);
185
193 static double Difference(double number1, double number2, bool toleranceIsAbsolute);
194};
195
196#endif /*MATHSCUSTOMFUNCTIONS_HPP_*/
bool Divides(double smallerNumber, double largerNumber)
double SmallPow(double x, unsigned exponent)
double SafeDivide(double numerator, double divisor)
unsigned SmallDifferenceMod(unsigned idxA, unsigned idxB, std::size_t range) noexcept
unsigned CeilDivide(unsigned numerator, unsigned denominator)
unsigned AdvanceMod(unsigned index, int increment, std::size_t range) noexcept
double Signum(double value)
static bool IsNearZero(double number, double tolerance)
static bool WithinAnyTolerance(double number1, double number2, double relTol=DBL_EPSILON, double absTol=DBL_EPSILON, bool printError=false)
static bool WithinTolerance(double number1, double number2, double tolerance, bool toleranceIsAbsolute)
static bool WithinRelativeTolerance(double number1, double number2, double tolerance)
static double Difference(double number1, double number2, bool toleranceIsAbsolute)
static bool WithinAbsoluteTolerance(double number1, double number2, double tolerance)