KisRollingMeanAccumulatorWrapper.h 2.09 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
/*
 *  Copyright (c) 2017 Dmitry Kazakov <dimula73@gmail.com>
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef KISROLLINGMEANACCUMULATORWRAPPER_H
#define KISROLLINGMEANACCUMULATORWRAPPER_H

#include <QtGlobal>
#include <QScopedPointer>
#include "kritaglobal_export.h"

/**
 * @brief A simple wrapper class that hides boost includes from QtCreator preventing it
 * from crashing when one adds boost's accumulator into a file
 */

class KRITAGLOBAL_EXPORT KisRollingMeanAccumulatorWrapper
{
public:
    /**
     * Create a rolling mean accumulator with window \p windowSize
     */
    KisRollingMeanAccumulatorWrapper(int windowSize);
    ~KisRollingMeanAccumulatorWrapper();

    /**
     * Add \p value to a set of numbers
     */
    void operator()(qreal value);

    /**
46 47
     * Get rolling mean of the numbers passed to the operator. If there are no elements
     * in the rolling window, returns NaN.
48 49 50
     */
    qreal rollingMean() const;

51 52 53 54 55 56 57 58 59 60 61
    /**
     * Get rolling mean of the numbers passed to the operator. If there are no elements
     * in the rolling window, returns 0.
     */
    qreal rollingMeanSafe() const;

    /**
     * Get the number of elements in the rolling window
     */
    int rollingCount() const;

62 63 64 65 66
    /**
     * Reset  accumulator and any stored value
     */
    void reset(int windowSize);

67 68 69 70 71 72
private:
    struct Private;
    const QScopedPointer<Private> m_d;
};

#endif // KISROLLINGMEANACCUMULATORWRAPPER_H