stat_bench::PlotOptions Class Reference

Class of options for plots. More...

#include <stat_bench/plot_options.h>

Collaboration diagram for stat_bench::PlotOptions:

Public Member Functions
	PlotOptions () noexcept
	Constructor.
	PlotOptions (PlotOption::Value option) noexcept
	Constructor.
auto	log_output () const noexcept -> bool
	Get whether to plot custom outputs in the log scale.
auto	log_output (bool value) noexcept -> PlotOptions &
	Set whether to plot custom outputs in the log scale.
auto	log_parameter () const noexcept -> bool
	Get whether to plot parameters in the log scale.
auto	log_parameter (bool value) noexcept -> PlotOptions &
	Set 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	subplot_column_parameter_name (const util::StringView &value) noexcept -> PlotOptions &
	Set parameter name used for columns of subplots.
auto	subplot_row_parameter_name () const noexcept -> util::StringView
	Get parameter name used for rows of subplots.
auto	subplot_row_parameter_name (const util::StringView &value) noexcept -> PlotOptions &
	Set parameter name used for rows of subplots.

Detailed Description

Class of options for plots.

Examples

configure_plotting.cpp.

Definition at line 30 of file plot_options.h.

Constructor & Destructor Documentation

PlotOptions() [1/2]

stat_bench::PlotOptions::PlotOptions ( )

noexcept

Constructor.

Definition at line 26 of file plot_options.cpp.

PlotOptions() [2/2]

stat_bench::PlotOptions::PlotOptions ( PlotOption::Value option )

noexcept

Constructor.

Parameters

[in]

option

Option.

Deprecated

This function exists for backward compatibility and will be removed in the future.

Definition at line 29 of file plot_options.cpp.

Member Function Documentation

log_output() [1/2]

auto stat_bench::PlotOptions::log_output ( ) const -> bool

nodiscardnoexcept

Get whether to plot custom outputs in the log scale.

Returns

Whether to plot custom outputs in the log scale.

Definition at line 61 of file plot_options.cpp.

log_output() [2/2]

auto stat_bench::PlotOptions::log_output ( bool value ) -> PlotOptions&

noexcept

Set whether to plot custom outputs in the log scale.

Parameters

[in]

value

Value.

Returns

This object.

Definition at line 40 of file plot_options.cpp.

log_parameter() [1/2]

auto stat_bench::PlotOptions::log_parameter ( ) const -> bool

nodiscardnoexcept

Get whether to plot parameters in the log scale.

Returns

Whether to plot parameters in the log scale.

Definition at line 57 of file plot_options.cpp.

log_parameter() [2/2]

auto stat_bench::PlotOptions::log_parameter ( bool value ) -> PlotOptions&

noexcept

Set whether to plot parameters in the log scale.

Parameters

[in]

value

Value.

Returns

This object.

Definition at line 35 of file plot_options.cpp.

subplot_column_parameter_name() [1/2]

auto stat_bench::PlotOptions::subplot_column_parameter_name ( ) const -> util::StringView

nodiscardnoexcept

Get parameter name used for columns of subplots.

Returns

Parameter name used for columns of subplots.

Definition at line 63 of file plot_options.cpp.

subplot_column_parameter_name() [2/2]

auto stat_bench::PlotOptions::subplot_column_parameter_name ( const util::StringView & value ) -> PlotOptions&

noexcept

Set parameter name used for columns of subplots.

Parameters

[in]

value

Value. (A string literal.)

Returns

This object.

Note

This function is assumed to be used with a string literal, and hold only the pointer to the string literal.

Definition at line 45 of file plot_options.cpp.

subplot_row_parameter_name() [1/2]

auto stat_bench::PlotOptions::subplot_row_parameter_name ( ) const -> util::StringView

nodiscardnoexcept

Get parameter name used for rows of subplots.

Returns

Parameter name used for rows of subplots.

Definition at line 68 of file plot_options.cpp.

subplot_row_parameter_name() [2/2]

auto stat_bench::PlotOptions::subplot_row_parameter_name ( const util::StringView & value ) -> PlotOptions&

noexcept

Set parameter name used for rows of subplots.

Parameters

[in]

value

Value. (A string literal.)

Returns

This object.

Note

This function is assumed to be used with a string literal, and hold only the pointer to the string literal.

Definition at line 51 of file plot_options.cpp.

---

The documentation for this class was generated from the following files:

• include/stat_bench/plot_options.h
• src/stat_bench/plot_options.cpp