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

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

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

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

Public Types
using	return_type = std::invoke_result_t<Function>
	Type returned by the function.

Public Member Functions
	function_iteration_parameter_value (Function function)
	Constructor.
auto	get () const -> return_type
	Get the current value.
auto	get (const Algorithm *) const -> return_type
	Get the current value.

Private Attributes
Function	function_
	Function.

Detailed Description

template<typename Algorithm, concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>
class num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >

Class of parameters values in iterations specified by functions.

Template Parameters

Algorithm	Type of the algorithm.
Value	Type of values.
Function	Type of the function.

Note

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

Thread Safety

Not thread-safe.

Definition at line 46 of file function_iteration_parameter_value.h.

Member Typedef Documentation

return_type

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>

using num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >::return_type = std::invoke_result_t<Function>

Type returned by the function.

Definition at line 49 of file function_iteration_parameter_value.h.

Constructor & Destructor Documentation

function_iteration_parameter_value()

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>

num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >::function_iteration_parameter_value ( Function function )

inlineexplicit

Constructor.

Parameters

[in]

function

Function.

Definition at line 56 of file function_iteration_parameter_value.h.

Member Function Documentation

get() [1/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>

auto num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >::get ( ) const -> return_type

inlinenodiscard

Get the current value.

Returns

Value.

Definition at line 64 of file function_iteration_parameter_value.h.

get() [2/2]

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>

auto num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >::get ( const Algorithm * ) const -> return_type

inlinenodiscard

Get the current value.

Returns

Value.

Definition at line 71 of file function_iteration_parameter_value.h.

Member Data Documentation

function_

template<typename Algorithm , concepts::formattable_iteration_parameter_value Value, concepts::getter_of< Value > Function>

Function num_collect::logging::iterations::function_iteration_parameter_value< Algorithm, Value, Function >::function_

private

Function.

Definition at line 78 of file function_iteration_parameter_value.h.

---

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

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