windowedstat.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <functional>
 
#include <promeki/function.h>
#include <promeki/namespace.h>
#include <promeki/datastream.h>
#include <promeki/error.h>
#include <promeki/list.h>
#include <promeki/result.h>
#include <promeki/string.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class Variant;
 
class WindowedStat {
        public:
                PROMEKI_DATATYPE(WindowedStat, DataTypeWindowedStat, 1)
 
                
                using Samples = ::promeki::List<double>;
 
                struct Stats {
                                int count = 0;
                                int capacity = 0;
                                double min = 0.0;
                                double max = 0.0;
                                double sum = 0.0;
                                double average = 0.0;
                                double stddev = 0.0;
                };
 
                using ValueFormatter = Function<String(double)>;
 
                WindowedStat() = default;
 
                explicit WindowedStat(int capacity);
 
                int capacity() const { return _capacity; }
 
                void setCapacity(int capacity);
 
                int count() const;
 
                bool isEmpty() const { return count() == 0; }
 
                bool isFull() const { return _full; }
 
                void push(double value);
 
                bool push(const Variant &v);
 
                void clear();
 
                // ------------------------------------------------------------
                // Statistics
                // ------------------------------------------------------------
 
                Stats stats() const;
 
                double min() const;
 
                double max() const;
 
                double average() const;
 
                double sum() const;
 
                double stddev() const;
 
                int sampleCount() const { return count(); }
 
                Samples values() const;
 
                // ------------------------------------------------------------
                // String / Variant round-trip
                // ------------------------------------------------------------
 
                String toFormattedString(const ValueFormatter &formatter = ValueFormatter()) const;
 
                String toString() const;
 
                static Result<WindowedStat> fromString(const String &s);
 
                bool operator==(const WindowedStat &other) const;
 
                bool operator!=(const WindowedStat &other) const { return !(*this == other); }
 
                Error writeToStream(DataStream &s) const;
 
                template <uint32_t V> static Result<WindowedStat> readFromStream(DataStream &s);
 
        private:
                Samples _samples;      
                int     _capacity = 0; 
                int     _head = 0;     
                bool    _full = false; 
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE