num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue > Class Template Reference

Class of parameters in iterations. More...

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

Inheritance diagram for num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >:

Collaboration diagram for num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >:

Public Member Functions
	iteration_parameter (std::string label, ParameterValue value)
	Constructor.
void	format_label_to (fmt::memory_buffer &buffer) const override
	Format the label with alignment.
void	format_summary_to (fmt::memory_buffer &buffer) const override
	Format the summary.
void	format_summary_to (fmt::memory_buffer &buffer, Algorithm *algorithm) const override
	Format the summary.
void	format_value_to (fmt::memory_buffer &buffer) const override
	Format the value with alignment.
void	format_value_to (fmt::memory_buffer &buffer, Algorithm *algorithm) const override
	Format the value with alignment.
auto	formatter () -> iteration_parameter_formatter< Value > &
	Access the formatter.
auto	label () const noexcept -> const std::string &override
	Get the label of this parameter.
auto	width () const -> index_type
	Get width.
auto	width (index_type value) -> iteration_parameter *
	Set width.
Public Member Functions inherited from num_collect::logging::iterations::iteration_parameter_base< Algorithm >
	iteration_parameter_base (const iteration_parameter_base &)=delete
	iteration_parameter_base (iteration_parameter_base &&)=delete
virtual	~iteration_parameter_base () noexcept=default
	Destructor.
auto	operator= (const iteration_parameter_base &) -> iteration_parameter_base &=delete
auto	operator= (iteration_parameter_base &&) -> iteration_parameter_base &=delete

Private Attributes
iteration_parameter_formatter< Value >	formatter_ {}
	Formatter.
std::string	label_
	Label.
ParameterValue	value_
	Parameter value.
index_type	width_ {impl::iteration_parameter_default_width}
	Width.

Additional Inherited Members
Protected Member Functions inherited from num_collect::logging::iterations::iteration_parameter_base< Algorithm >
	iteration_parameter_base () noexcept=default
	Constructor.

Detailed Description

template<typename Algorithm, concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>
class num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >

Class of parameters in iterations.

Template Parameters

Algorithm	Type of the algorithm.
Value	Type of values.
ParameterValue	Class of parameters values in iterations specified by variables.

Note

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

Thread Safety

Not thread-safe.

Definition at line 137 of file iteration_parameter.h.

Constructor & Destructor Documentation

iteration_parameter()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::iteration_parameter ( std::string label, ParameterValue value )

inline

Constructor.

Parameters

[in]	label	Label.
[in]	value	Parameter value.

Definition at line 145 of file iteration_parameter.h.

Member Function Documentation

format_label_to()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

void num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::format_label_to ( fmt::memory_buffer & buffer ) const

inlineoverridevirtual

Format the label with alignment.

Parameters

[out]

buffer

Buffer to write the output.

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 153 of file iteration_parameter.h.

format_summary_to() [1/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

void num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::format_summary_to ( fmt::memory_buffer & buffer ) const

inlineoverridevirtual

Format the summary.

Parameters

[out]

buffer

Buffer to write the output.

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 171 of file iteration_parameter.h.

format_summary_to() [2/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

void num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::format_summary_to ( fmt::memory_buffer & buffer, Algorithm * algorithm ) const

inlineoverridevirtual

Format the summary.

Parameters

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

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 194 of file iteration_parameter.h.

format_value_to() [1/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

void num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::format_value_to ( fmt::memory_buffer & buffer ) const

inlineoverridevirtual

Format the value with alignment.

Parameters

[out]

buffer

Buffer to write the output.

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 162 of file iteration_parameter.h.

format_value_to() [2/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

void num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::format_value_to ( fmt::memory_buffer & buffer, Algorithm * algorithm ) const

inlineoverridevirtual

Format the value with alignment.

Parameters

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

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 183 of file iteration_parameter.h.

formatter()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

auto num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::formatter ( ) -> iteration_parameter_formatter<Value>&

inlinenodiscard

Access the formatter.

Returns

Formatter.

Definition at line 236 of file iteration_parameter.h.

label()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

auto num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::label ( ) const -> const std::string&

inlinenodiscardoverridevirtualnoexcept

Get the label of this parameter.

Returns

label.

Implements num_collect::logging::iterations::iteration_parameter_base< Algorithm >.

Definition at line 206 of file iteration_parameter.h.

width() [1/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

auto num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::width ( ) const -> index_type

inlinenodiscard

Get width.

Returns

Width.

Definition at line 229 of file iteration_parameter.h.

width() [2/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

auto num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::width ( index_type value ) -> iteration_parameter*

inline

Set width.

Parameters

[in]

value

Value

Returns

This object.

Definition at line 216 of file iteration_parameter.h.

Member Data Documentation

formatter_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

iteration_parameter_formatter<Value> num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::formatter_ {}

private

Formatter.

Definition at line 251 of file iteration_parameter.h.

label_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

std::string num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::label_

private

Label.

Definition at line 242 of file iteration_parameter.h.

value_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

ParameterValue num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::value_

private

Parameter value.

Definition at line 245 of file iteration_parameter.h.

width_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::iteration_parameter_value< Algorithm, Value > ParameterValue>

index_type num_collect::logging::iterations::iteration_parameter< Algorithm, Value, ParameterValue >::width_ {impl::iteration_parameter_default_width}

private

Width.

Definition at line 248 of file iteration_parameter.h.

---

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

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