parameter_to_time_violin_plot.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 <string>
 
#include "stat_bench/param/parameter_name.h"
#include "stat_bench/plot_options.h"
#include "stat_bench/plots/i_plot.h"
#include "stat_bench/util/utf8_string.h"
 
namespace stat_bench {
namespace plots {

class ParameterToTimeViolinPlot final : public IPlot {
public:
    ParameterToTimeViolinPlot(
        param::ParameterName parameter_name, PlotOptions options);
 
    ParameterToTimeViolinPlot(const ParameterToTimeViolinPlot&) = delete;
    ParameterToTimeViolinPlot(ParameterToTimeViolinPlot&&) = delete;
    auto operator=(const ParameterToTimeViolinPlot&)
        -> ParameterToTimeViolinPlot& = delete;
    auto operator=(ParameterToTimeViolinPlot&&)
        -> ParameterToTimeViolinPlot& = delete;

    ~ParameterToTimeViolinPlot() override = default;

    [[nodiscard]] auto name_for_file() const
        -> const util::Utf8String& override;

    void write(const measurer::MeasurerName& measurer_name,
        const BenchmarkGroupName& group_name,
        const std::vector<measurer::Measurement>& measurements,
        const std::string& file_path) override;
 
private:
    [[nodiscard]] static auto create_name_for_file(
        const param::ParameterName& parameter_name, const PlotOptions& options)
        -> util::Utf8String;

    param::ParameterName parameter_name_;

    PlotOptions options_;

    util::Utf8String name_for_file_;
};
 
}  // namespace plots
}  // namespace stat_bench