mean_processing_time_measurer.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 <cstddef>
#include <string>
 
#include "stat_bench/measurer/i_measurer.h"
#include "stat_bench/measurer/measurer_name.h"
 
namespace stat_bench {
namespace measurer {

class MeanProcessingTimeMeasurer final : public IMeasurer {
public:
    MeanProcessingTimeMeasurer(double min_sample_duration_sec,
        std::size_t samples, std::size_t min_warming_up_iterations,
        double min_warming_up_duration_sec)
        : min_sample_duration_sec_(min_sample_duration_sec),
          samples_(samples),
          min_warming_up_iterations_(min_warming_up_iterations),
          min_warming_up_duration_sec_(min_warming_up_duration_sec) {}

    [[nodiscard]] auto name() const noexcept -> const MeasurerName& override {
        return name_;
    }

    [[nodiscard]] auto measure(bench_impl::IBenchmarkCase* bench_case,
        const BenchmarkCondition& cond) const -> Measurement override;
 
    MeanProcessingTimeMeasurer(const MeanProcessingTimeMeasurer&) = delete;
    MeanProcessingTimeMeasurer(MeanProcessingTimeMeasurer&&) = delete;
    auto operator=(const MeanProcessingTimeMeasurer&)
        -> MeanProcessingTimeMeasurer& = delete;
    auto operator=(MeanProcessingTimeMeasurer&&)
        -> MeanProcessingTimeMeasurer& = delete;

    ~MeanProcessingTimeMeasurer() override = default;
 
private:
    const MeasurerName name_{"Mean Processing Time"};

    double min_sample_duration_sec_;

    std::size_t samples_;

    std::size_t min_warming_up_iterations_;

    double min_warming_up_duration_sec_;
};
 
}  // namespace measurer
}  // namespace stat_bench