floating_point.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Daniel Abele
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_MATH_FLOATING_POINT_H
#define MIO_MATH_FLOATING_POINT_H
 
#include "memilio/config.h"
 
#include <algorithm>
#include <cmath>
#include <limits>
 
namespace mio
{
 
template <typename FP>
FP abs_max(FP v1, FP v2)
{
    using std::abs;
    using std::max;
    return max<FP>(abs(v1), abs(v2));
}
 
template <typename FP>
bool floating_point_equal(FP v1, FP v2, FP abs_tol = 0, FP rel_tol = std::numeric_limits<FP>::min())
{
    using std::abs;
    auto diff = abs(v1 - v2);
    return diff <= abs_tol || diff <= abs_max<FP>(v1, v2) * rel_tol;
}
 
template <typename FP>
bool floating_point_less(FP v1, FP v2, FP abs_tol = 0, FP rel_tol = std::numeric_limits<FP>::min())
{
    auto diff = v1 - v2;
    return diff < -(abs_tol + rel_tol * abs_max<FP>(v1, v2));
}
 
template <typename FP>
bool floating_point_greater(FP v1, FP v2, FP abs_tol = 0, FP rel_tol = std::numeric_limits<FP>::min())
{
    return floating_point_less<FP>(v2, v1, abs_tol, rel_tol);
}
 
template <typename FP>
bool floating_point_less_equal(FP v1, FP v2, FP abs_tol = 0, FP rel_tol = std::numeric_limits<FP>::min())
{
    return !floating_point_greater<FP>(v1, v2, abs_tol, rel_tol);
}
 
template <typename FP>
bool floating_point_greater_equal(FP v1, FP v2, FP abs_tol = 0, FP rel_tol = std::numeric_limits<FP>::min())
{
    return !floating_point_less<FP>(v1, v2, abs_tol, rel_tol);
}
 
} // namespace mio
 
#endif // MIO_MATH_FLOATING_POINT_H