KiCad PCB EDA Suite
Loading...
Searching...
No Matches
numeric.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
29#ifndef NUMERIC__H
30#define NUMERIC__H
31
32#include <cmath>
33
34namespace KI_TEST
35{
36
42template <typename T>
43bool IsWithinWrapped( T aValue, T aNominal, T aWrap, T aError )
44{
45 // Compute shortest signed distance on a ring
46 double diff = std::fmod( static_cast<double>( aValue - aNominal ), static_cast<double>( aWrap ) );
47
48 if( diff > aWrap / 2.0 )
49 diff -= aWrap;
50 else if( diff < -aWrap / 2.0 )
51 diff += aWrap;
52
53 return std::abs( diff ) <= aError;
54}
55
61template <typename T> bool IsWithin( T aValue, T aNominal, T aError )
62{
63 return ( aValue >= aNominal - aError ) && ( aValue <= aNominal + aError );
64}
65
72template <typename T> bool IsWithinBounds( T aValue, T aNominal, T aErrorAbove, T aErrorBelow )
73{
74 return ( aValue >= aNominal - aErrorBelow ) && ( aValue <= aNominal + aErrorAbove );
75}
76
80template <typename T> bool IsWithinAndBelow( T aValue, T aNominal, T aErrorBelow )
81{
82 return IsWithinBounds( aValue, aNominal, 0, aErrorBelow );
83}
84
88template <typename T> bool IsWithinAndAbove( T aValue, T aNominal, T aErrorAbove )
89{
90 return IsWithinBounds( aValue, aNominal, aErrorAbove, 0 );
91}
92
93} // namespace KI_TEST
94
95#endif // NUMERIC__H
bool IsWithinWrapped(T aValue, T aNominal, T aWrap, T aError)
Check if a value is within a tolerance of a nominal value, wrapping to a given val.
Definition: numeric.h:43
bool IsWithin(T aValue, T aNominal, T aError)
Check if a value is within a tolerance of a nominal value.
Definition: numeric.h:61
bool IsWithinAndAbove(T aValue, T aNominal, T aErrorAbove)
value is in range [aNominal, aNominal + aErrorAbove]
Definition: numeric.h:88
bool IsWithinAndBelow(T aValue, T aNominal, T aErrorBelow)
value is in range [aNominal - aErrorBelow, aNominal]
Definition: numeric.h:80
bool IsWithinBounds(T aValue, T aNominal, T aErrorAbove, T aErrorBelow)
Check if a value is within a tolerance of a nominal value, with different allowances for errors above...
Definition: numeric.h:72
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:400