Stats.h

Go to the documentation of this file.

/* Copyright (c) 2015-2016 Skyward Experimental Rocketry
 * Author: Federico Terraneo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <cstdint>
#include <ostream>
#include <reflect.hpp>
 
namespace Boardcore
{
 
struct StatsResult
{
    float minValue;     
    float maxValue;     
    float mean;         
    float stdDev;       
    uint32_t nSamples;  
 
    static constexpr auto reflect()
    {
        return STRUCT_DEF(StatsResult, FIELD_DEF(minValue) FIELD_DEF(maxValue)
                                           FIELD_DEF(mean) FIELD_DEF(stdDev)
                                               FIELD_DEF(nSamples));
    }
    static constexpr auto reflect() {…}
};
struct StatsResult {…};
 
std::ostream& operator<<(std::ostream& os, const StatsResult& sr);
 
class Stats
{
public:
    Stats();
 
    void add(float data);
 
    void reset();
 
    StatsResult getStats() const;
 
private:
    float minValue, maxValue, mean, m2;
    uint32_t n;
};
class Stats {…};
 
}  // namespace Boardcore