benchmark_group.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 <memory>
 
#include "stat_bench/bench_impl/benchmark_group_config.h"
#include "stat_bench/bench_impl/i_benchmark_case.h"
#include "stat_bench/benchmark_case_name.h"
#include "stat_bench/benchmark_group_name.h"
#include "stat_bench/filters/composed_filter.h"
#include "stat_bench/util/ordered_map.h"
 
namespace stat_bench {
namespace bench_impl {

class BenchmarkGroup {
public:
    explicit BenchmarkGroup(BenchmarkGroupName name);

    [[nodiscard]] auto name() const noexcept -> const BenchmarkGroupName&;

    void add(std::shared_ptr<IBenchmarkCase> bench_case);

    void filter_by(const filters::ComposedFilter& filter);

    [[nodiscard]] auto cases() const noexcept -> const
        util::OrderedMap<BenchmarkCaseName, std::shared_ptr<IBenchmarkCase>>&;

    [[nodiscard]] auto config() noexcept -> BenchmarkGroupConfig&;

    [[nodiscard]] auto config() const noexcept -> const BenchmarkGroupConfig&;
 
private:
    BenchmarkGroupName name_;

    util::OrderedMap<BenchmarkCaseName, std::shared_ptr<IBenchmarkCase>>
        cases_{};

    BenchmarkGroupConfig config_{};
};
 
}  // namespace bench_impl
}  // namespace stat_bench