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

Class of parameters values in iterations specified by variables. More...

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

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

Public Member Functions
	variable_iteration_parameter_value (const Value &value)
	Constructor.
auto	get () const noexcept -> const Value &
	Get the current value.
auto	get (const Algorithm *) const noexcept -> const Value &
	Get the current value.

Private Attributes
const Value *	value_
	Pointer to the value.

Detailed Description

template<typename Algorithm, concepts::formattable_iteration_parameter_value Value>
class num_collect::logging::iterations::variable_iteration_parameter_value< Algorithm, Value >

Class of parameters values in iterations specified by variables.

Template Parameters

Algorithm	Type of the algorithm.
Value	Type of values.

Note

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

Thread Safety

Not thread-safe.

Definition at line 39 of file variable_iteration_parameter_value.h.

Constructor & Destructor Documentation

variable_iteration_parameter_value()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value>

num_collect::logging::iterations::variable_iteration_parameter_value< Algorithm, Value >::variable_iteration_parameter_value ( const Value & value )

inlineexplicit

Constructor.

Parameters

[in]

value

Value.

Definition at line 46 of file variable_iteration_parameter_value.h.

Member Function Documentation

get() [1/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value>

auto num_collect::logging::iterations::variable_iteration_parameter_value< Algorithm, Value >::get ( ) const -> const Value&

inlinenodiscardnoexcept

Get the current value.

Returns

Value.

Definition at line 54 of file variable_iteration_parameter_value.h.

get() [2/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value>

auto num_collect::logging::iterations::variable_iteration_parameter_value< Algorithm, Value >::get ( const Algorithm * ) const -> const Value&

inlinenodiscardnoexcept

Get the current value.

Returns

Value.

Definition at line 61 of file variable_iteration_parameter_value.h.

Member Data Documentation

value_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value>

const Value* num_collect::logging::iterations::variable_iteration_parameter_value< Algorithm, Value >::value_

private

Pointer to the value.

Definition at line 68 of file variable_iteration_parameter_value.h.

---

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

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