mathutils.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_MATH_MATHUTILS_H
#define SWIFT_MISC_MATH_MATHUTILS_H
 
#include <QtCore/qmath.h>
 
#include <cmath>
#include <numeric>
 
#include <QPair>
#include <QRandomGenerator>
 
#include "misc/swiftmiscexport.h"
 
namespace swift::misc::math
{
    class SWIFT_MISC_EXPORT CMathUtils
    {
    public:
        CMathUtils() = delete;
 
        static double round(double value, int digits);
 
        static double roundEpsilon(double value, double epsilon);
 
        static bool epsilonEqual(float v1, float v2, float epsilon = 1E-06f);
        static bool epsilonEqual(double v1, double v2, double epsilon = 1E-06);
        static bool epsilonEqualLimits(double v1, double v2)
        {
            return qAbs(v1 - v2) <= std::numeric_limits<double>::epsilon();
        }
 
        static bool epsilonZero(double v, double epsilon) { return epsilonEqual(v, 0.0, epsilon); }
        static bool epsilonZero(double v) { return epsilonEqual(v, 0.0, 1E-06); }
        static inline bool epsilonZeroLimits(double v) { return qAbs(v) <= std::numeric_limits<double>::epsilon(); }
 
        static inline double trunc(double value, double epsilon = 1e-10)
        {
            return value < 0 ? ceil(value - epsilon) : floor(value + epsilon);
        }
 
        static inline double fract(double value)
        {
            double unused;
            return modf(value, &unused);
        }
 
        static double deg2rad(double degree);
 
        static double rad2deg(double radians);
 
        static double normalizeDegrees180(double degrees);
 
        static double normalizeDegrees360(double degrees);
 
        static QRandomGenerator &randomGenerator();
 
        static int randomInteger(int low, int high);
 
        static double randomDouble(double max = 1);
 
        static bool randomBool();
 
        static int roundToMultipleOf(int value, int divisor);
 
        static QString fractionalPartAsString(double value, int width = -1);
 
        static double sum(const QList<double> &values);
 
        static double mean(const QList<double> &values);
 
        static double standardDeviation(const QList<double> &values);
 
        static QPair<double, double> standardDeviationAndMean(const QList<double> &values);
 
    private:
        static double variance(const QList<double> &values);
 
        static QList<double> squaredDifferences(const QList<double> &values);
 
        static QList<double> squaredDifferences(const QList<double> &values, double meanValue);
    };
} // namespace swift::misc::math
 
#endif // SWIFT_MISC_MATH_MATHUTILS_H