stat.h

Go to the documentation of this file.

#pragma once
 
#include "../config.h"
 
#include <cmath>
 
namespace alfi::util::stat {
    template <typename Number = DefaultNumber, template <typename, typename...> class Container = DefaultContainer>
    Number mean(const Container<Number>& container) {
        if (container.empty()) {
            return 0;
        }
        Number sum = 0;
        for (const auto& value : container) {
            sum += value;
        }
        return sum / container.size();
    }

    template <typename Number = DefaultNumber, template <typename, typename...> class Container = DefaultContainer>
    Number mean_abs(const Container<Number>& container) {
        if (container.empty()) {
            return 0;
        }
        Number sum = 0;
        for (const auto& value : container) {
            sum += std::abs(value);
        }
        return sum / container.size();
    }

    template <typename Number = DefaultNumber, template <typename, typename...> class Container = DefaultContainer>
    Number mean_square(const Container<Number>& container) {
        if (container.empty()) {
            return 0;
        }
        Number sum = 0;
        for (const auto& value : container) {
            sum += value * value;
        }
        return sum / container.size();
    }

    template <typename Number = DefaultNumber, template <typename, typename...> class Container = DefaultContainer>
    Number rms(const Container<Number>& container) {
        return std::sqrt(mean_square(container));
    }

    template <typename Number = DefaultNumber, template <typename, typename...> class Container = DefaultContainer>
    Number var(const Container<Number>& container, bool biased = false) {
        if (container.size() <= 1) {
            return 0;
        }
        const auto m = mean(container);
        Number sum = 0;
        for (const auto& value : container) {
            sum += (value - m) * (value - m);
        }
        return sum / (biased ? container.size() : container.size() - 1);
    }
}