num_collect::logging::iterations::iteration_parameter_base< Algorithm > Class Template Reference

Base class of parameters in iterations. More...

#include <num_collect/logging/iterations/iteration_parameter.h>

Inheritance diagram for num_collect::logging::iterations::iteration_parameter_base< Algorithm >:

Collaboration diagram for num_collect::logging::iterations::iteration_parameter_base< Algorithm >:

Public Member Functions
	iteration_parameter_base (const iteration_parameter_base &)=delete
	iteration_parameter_base (iteration_parameter_base &&)=delete
virtual	~iteration_parameter_base () noexcept=default
	Destructor.
virtual void	format_label_to (fmt::memory_buffer &buffer) const =0
	Format the label with alignment.
virtual void	format_summary_to (fmt::memory_buffer &buffer) const =0
	Format the summary.
virtual void	format_summary_to (fmt::memory_buffer &buffer, Algorithm *algorithm) const =0
	Format the summary.
virtual void	format_value_to (fmt::memory_buffer &buffer) const =0
	Format the value with alignment.
virtual void	format_value_to (fmt::memory_buffer &buffer, Algorithm *algorithm) const =0
	Format the value with alignment.
virtual auto	label () const noexcept -> const std::string &=0
	Get the label of this parameter.
auto	operator= (const iteration_parameter_base &) -> iteration_parameter_base &=delete
auto	operator= (iteration_parameter_base &&) -> iteration_parameter_base &=delete

Protected Member Functions
	iteration_parameter_base () noexcept=default
	Constructor.

Detailed Description

template<typename Algorithm>
class num_collect::logging::iterations::iteration_parameter_base< Algorithm >

Base class of parameters in iterations.

Template Parameters

Algorithm

Type of the algorithm.

Note

User should not use this class directly. Use num_collect::logging::iterations::iteration_logger.

Definition at line 54 of file iteration_parameter.h.

Member Function Documentation

format_label_to()

template<typename Algorithm >

virtual void num_collect::logging::iterations::iteration_parameter_base< Algorithm >::format_label_to ( fmt::memory_buffer & buffer ) const

pure virtual

Format the label with alignment.

Parameters

[out]

buffer

Buffer to write the output.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

format_summary_to() [1/2]

template<typename Algorithm >

virtual void num_collect::logging::iterations::iteration_parameter_base< Algorithm >::format_summary_to ( fmt::memory_buffer & buffer ) const

pure virtual

Format the summary.

Parameters

[out]

buffer

Buffer to write the output.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

format_summary_to() [2/2]

template<typename Algorithm >

virtual void num_collect::logging::iterations::iteration_parameter_base< Algorithm >::format_summary_to ( fmt::memory_buffer & buffer, Algorithm * algorithm ) const

pure virtual

Format the summary.

Parameters

[out]	buffer	Buffer to write the output.
[in]	algorithm	Algorithm.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

format_value_to() [1/2]

template<typename Algorithm >

virtual void num_collect::logging::iterations::iteration_parameter_base< Algorithm >::format_value_to ( fmt::memory_buffer & buffer ) const

pure virtual

Format the value with alignment.

Parameters

[out]

buffer

Buffer to write the output.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

format_value_to() [2/2]

template<typename Algorithm >

virtual void num_collect::logging::iterations::iteration_parameter_base< Algorithm >::format_value_to ( fmt::memory_buffer & buffer, Algorithm * algorithm ) const

pure virtual

Format the value with alignment.

Parameters

[out]	buffer	Buffer to write the output.
[in]	algorithm	Algorithm.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

label()

template<typename Algorithm >

virtual auto num_collect::logging::iterations::iteration_parameter_base< Algorithm >::label ( ) const -> const std::string &

nodiscardpure virtualnoexcept

Get the label of this parameter.

Returns

label.

Implemented in num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >.

---

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

• include/num_collect/logging/iterations/iteration_parameter.h