cpp-stat-bench 0.24.0
Benchmark library with statistics for C++.
Loading...
Searching...
No Matches
plot_options.h
Go to the documentation of this file.
1/*
2 * Copyright 2025 MusicScience37 (Kenta Kabashima)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
20#pragma once
21
24
25namespace stat_bench {
26
31public:
35 PlotOptions() noexcept;
36
45 PlotOptions(PlotOption::Value option) noexcept; // NOLINT
46
53 auto log_parameter(bool value) noexcept -> PlotOptions&;
54
61 auto log_output(bool value) noexcept -> PlotOptions&;
62
72 auto subplot_column_parameter_name(const util::StringView& value) noexcept
73 -> PlotOptions&;
74
84 auto subplot_row_parameter_name(const util::StringView& value) noexcept
85 -> PlotOptions&;
86
92 [[nodiscard]] auto log_parameter() const noexcept -> bool;
93
99 [[nodiscard]] auto log_output() const noexcept -> bool;
100
106 [[nodiscard]] auto subplot_column_parameter_name() const noexcept
108
114 [[nodiscard]] auto subplot_row_parameter_name() const noexcept
116
117private:
119 bool log_parameter_;
120
122 bool log_output_;
123
125 util::StringView subplot_column_parameter_name_;
126
128 util::StringView subplot_row_parameter_name_;
129};
130
131} // namespace stat_bench
unsigned Value
Type of values.
Definition plot_option.h:33
PlotOptions() noexcept
Constructor.
auto subplot_row_parameter_name() const noexcept -> util::StringView
Get parameter name used for rows of subplots.
auto log_parameter() const noexcept -> bool
Get whether to plot parameters in the log scale.
auto subplot_column_parameter_name() const noexcept -> util::StringView
Get parameter name used for columns of subplots.
auto log_output() const noexcept -> bool
Get whether to plot custom outputs in the log scale.
Class of view of strings.
Definition string_view.h:34
Namespace of stat_bench source codes.
Definition of PlotOption enumeration.
Declaration of check_glob_pattern function.