KisRollingSumAccumulatorWrapper Class Reference

A simple wrapper class that hides boost includes from QtCreator preventing it from crashing when one adds boost's accumulator into a file. More...

#include <KisRollingSumAccumulatorWrapper.h>

Classes
struct	Private

Public Member Functions
	KisRollingSumAccumulatorWrapper (int windowSize)
void	operator() (qreal value)
void	reset (int windowSize)
int	rollingCount () const
qreal	rollingSum () const
	~KisRollingSumAccumulatorWrapper ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

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

Definition at line 13 of file KisRollingSumAccumulatorWrapper.h.

Constructor & Destructor Documentation

KisRollingSumAccumulatorWrapper()

KisRollingSumAccumulatorWrapper::KisRollingSumAccumulatorWrapper

(

int

windowSize

)

Create a rolling sum and count accumulator with window windowSize

Definition at line 27 of file KisRollingSumAccumulatorWrapper.cpp.

    : m_d(new Private(windowSize))
{
}

~KisRollingSumAccumulatorWrapper()

KisRollingSumAccumulatorWrapper::~KisRollingSumAccumulatorWrapper

(

)

Definition at line 32 of file KisRollingSumAccumulatorWrapper.cpp.

{
}

Member Function Documentation

operator()()

void KisRollingSumAccumulatorWrapper::operator()

(

qreal

value

)

Add value to a set of numbers

Definition at line 36 of file KisRollingSumAccumulatorWrapper.cpp.

{
    m_d->accumulator(value);
}

References m_d, and value().

reset()

void KisRollingSumAccumulatorWrapper::reset

(

int

windowSize

)

Reset accumulator and any stored value

Definition at line 51 of file KisRollingSumAccumulatorWrapper.cpp.

{
    m_d->accumulator =
        accumulator_set<qreal, stats<tag::rolling_sum, tag::rolling_count>>(
            tag::rolling_window::window_size = windowSize);
}

References m_d.

rollingCount()

int KisRollingSumAccumulatorWrapper::rollingCount

(

)

const

Get the number of elements in the rolling window

Definition at line 46 of file KisRollingSumAccumulatorWrapper.cpp.

{
    return boost::accumulators::rolling_count(m_d->accumulator);
}

References m_d.

rollingSum()

qreal KisRollingSumAccumulatorWrapper::rollingSum

(

)

const

Get rolling sum of the numbers passed to the operator

Definition at line 41 of file KisRollingSumAccumulatorWrapper.cpp.

{
    return boost::accumulators::rolling_sum(m_d->accumulator);
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisRollingSumAccumulatorWrapper::m_d

private

Definition at line 45 of file KisRollingSumAccumulatorWrapper.h.

---

The documentation for this class was generated from the following files:

• libs/global/KisRollingSumAccumulatorWrapper.h
• libs/global/KisRollingSumAccumulatorWrapper.cpp