num_collect::logging::iterations::iteration_logger_mixin< Derived > Class Template Reference

Class to incorporate num_collect::logging::iterations::iteration_logger in algorithms. More...

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

Inheritance diagram for num_collect::logging::iterations::iteration_logger_mixin< Derived >:

Collaboration diagram for num_collect::logging::iterations::iteration_logger_mixin< Derived >:

Public Member Functions
	iteration_logger_mixin ()=default
	Constructor.
void	configure_iteration_logger (num_collect::logging::iterations::iteration_logger< Derived > &iteration_logger) const
	Configure an iteration logger.
auto	initialize_iteration_logger () -> num_collect::logging::iterations::iteration_logger< Derived > &
	Get the iteration logger.

Private Attributes
std::optional< num_collect::logging::iterations::iteration_logger< Derived > >	iteration_logger_ {}
	Iteration logger.

Detailed Description

template<typename Derived>
class num_collect::logging::iterations::iteration_logger_mixin< Derived >

Class to incorporate num_collect::logging::iterations::iteration_logger in algorithms.

Inherit this class to use num_collect::logging::iterations::iteration_logger with the common interface.

Template Parameters

Derived

Derived class.

Definition at line 38 of file iteration_logger_mixin.h.

Member Function Documentation

configure_iteration_logger()

template<typename Derived >

void num_collect::logging::iterations::iteration_logger_mixin< Derived >::configure_iteration_logger ( num_collect::logging::iterations::iteration_logger< Derived > & iteration_logger ) const

inline

Configure an iteration logger.

Parameters

[in]

iteration_logger

Iteration logger.

Definition at line 50 of file iteration_logger_mixin.h.

initialize_iteration_logger()

template<typename Derived >

auto num_collect::logging::iterations::iteration_logger_mixin< Derived >::initialize_iteration_logger ( ) -> num_collect::logging::iterations::iteration_logger<Derived>&

inline

Get the iteration logger.

Note

This will automatically call configure_iteration_logger function..

Returns

Iteration logger.

Definition at line 64 of file iteration_logger_mixin.h.

Member Data Documentation

iteration_logger_

template<typename Derived >

std::optional<num_collect::logging::iterations::iteration_logger<Derived> > num_collect::logging::iterations::iteration_logger_mixin< Derived >::iteration_logger_ {}

private

Iteration logger.

Definition at line 78 of file iteration_logger_mixin.h.

---

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

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