numeric.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef NUMERIC__H
#define NUMERIC__H
 
#include <cmath>
 
namespace KI_TEST
{

template <typename T>
bool IsWithinWrapped( T aValue, T aNominal, T aWrap, T aError )
{
    // Compute shortest signed distance on a ring
    double diff = std::fmod( static_cast<double>( aValue - aNominal ), static_cast<double>( aWrap ) );
 
    if( diff > aWrap / 2.0 )
        diff -= aWrap;
    else if( diff < -aWrap / 2.0 )
        diff += aWrap;
 
    return std::abs( diff ) <= aError;
}

template <typename T> bool IsWithin( T aValue, T aNominal, T aError )
{
    return ( aValue >= aNominal - aError ) && ( aValue <= aNominal + aError );
}

template <typename T> bool IsWithinBounds( T aValue, T aNominal, T aErrorAbove, T aErrorBelow )
{
    return ( aValue >= aNominal - aErrorBelow ) && ( aValue <= aNominal + aErrorAbove );
}

template <typename T> bool IsWithinAndBelow( T aValue, T aNominal, T aErrorBelow )
{
    return IsWithinBounds( aValue, aNominal, 0, aErrorBelow );
}

template <typename T> bool IsWithinAndAbove( T aValue, T aNominal, T aErrorAbove )
{
    return IsWithinBounds( aValue, aNominal, aErrorAbove, 0 );
}
 
} // namespace KI_TEST
 
#endif // NUMERIC__H