CumulativeValue.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Data/CumulativeValue.h
//! @brief     Defines class CumulativeValue.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_DEVICE_DATA_CUMULATIVEVALUE_H
#define BORNAGAIN_DEVICE_DATA_CUMULATIVEVALUE_H
 
//! The cumulative value with average and rms on-the-flight calculations.
//! @ingroup tools
 
class CumulativeValue {
public:
    CumulativeValue() { clear(); }
 
    void clear();
    void setContent(double value) { m_sum = value; }
    void add(double value, double weight = 1.0);
 
    int getNumberOfEntries() const { return m_n_entries; }
    double getContent() const { return m_sum; }
    double getAverage() const { return m_average; }
    double getRMS() const;
 
private:
    int m_n_entries;
    double m_sum;
    double m_average;
    double m_rms2; // sum[ (x-x_aver)^2]/nentries
    double m_sum_of_weights;
};
 
bool operator<(const CumulativeValue& lhs, const CumulativeValue& rhs);
bool operator>(const CumulativeValue& lhs, const CumulativeValue& rhs);
 
#endif // BORNAGAIN_DEVICE_DATA_CUMULATIVEVALUE_H
#endif // USER_API