statistics.h

Go to the documentation of this file.

/*
 * Copyright 2021 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <utility>
#include <vector>
 
namespace stat_bench {
namespace stat {

class Statistics {
public:
    Statistics(std::vector<double> unsorted_samples,
        std::vector<double> sorted_samples, double mean, double max, double min,
        double median, double variance, double standard_deviation,
        double standard_error)
        : unsorted_samples_(std::move(unsorted_samples)),
          sorted_samples_(std::move(sorted_samples)),
          mean_(mean),
          max_(max),
          min_(min),
          median_(median),
          variance_(variance),
          standard_deviation_(standard_deviation),
          standard_error_(standard_error) {}

    [[nodiscard]] auto unsorted_samples() const noexcept
        -> const std::vector<double>& {
        return unsorted_samples_;
    }

    [[nodiscard]] auto sorted_samples() const noexcept
        -> const std::vector<double>& {
        return sorted_samples_;
    }

    [[nodiscard]] auto mean() const noexcept -> double { return mean_; }

    [[nodiscard]] auto max() const noexcept -> double { return max_; }

    [[nodiscard]] auto min() const noexcept -> double { return min_; }

    [[nodiscard]] auto median() const noexcept -> double { return median_; }

    [[nodiscard]] auto variance() const noexcept -> double { return variance_; }

    [[nodiscard]] auto standard_deviation() const noexcept -> double {
        return standard_deviation_;
    }

    [[nodiscard]] auto standard_error() const noexcept -> double {
        return standard_error_;
    }
 
private:
    std::vector<double> unsorted_samples_;

    std::vector<double> sorted_samples_;

    double mean_;

    double max_;

    double min_;

    double median_;

    double variance_;

    double standard_deviation_;

    double standard_error_;
};
 
}  // namespace stat
}  // namespace stat_bench