benchmark_group_register.h

Go to the documentation of this file.

/*
 * Copyright 2025 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 "stat_bench/bench_impl/benchmark_group.h"
#include "stat_bench/benchmark_group_name.h"
#include "stat_bench/plot_options.h"
#include "stat_bench/util/string_view.h"
 
namespace stat_bench {
namespace bench_impl {

class BenchmarkGroupRegister {
public:
    explicit BenchmarkGroupRegister(const BenchmarkGroupName& name) noexcept;

    auto add_parameter_to_time_line_plot(util::StringView parameter_name,
        PlotOptions options = PlotOptions()) noexcept
        -> BenchmarkGroupRegister&;

    [[deprecated("Use add_parameter_to_time_line_plot instead.")]] auto
    add_parameter_to_time_line_plot_log(
        util::StringView parameter_name) noexcept -> BenchmarkGroupRegister&;

    auto add_parameter_to_time_violin_plot(util::StringView parameter_name,
        PlotOptions options = PlotOptions()) noexcept
        -> BenchmarkGroupRegister&;

    auto add_parameter_to_time_box_plot(util::StringView parameter_name,
        PlotOptions options = PlotOptions()) noexcept
        -> BenchmarkGroupRegister&;

    auto add_parameter_to_output_line_plot(util::StringView parameter_name,
        util::StringView custom_output_name,
        PlotOptions options = PlotOptions()) noexcept
        -> BenchmarkGroupRegister&;

    auto add_time_to_output_by_parameter_line_plot(
        util::StringView parameter_name, util::StringView custom_output_name,
        PlotOptions options = PlotOptions()) noexcept
        -> BenchmarkGroupRegister&;
 
private:
    BenchmarkGroup* group_{nullptr};
};
 
}  // namespace bench_impl
}  // namespace stat_bench