shammodels::SolverLog Struct Reference

Class holding the logs of the solver /todo add a variable to keep only a definite number of steps in the step_logs. More...

#include <shammodels/common/include/shammodels/common/SolverLog.hpp>

Collaboration diagram for shammodels::SolverLog:

Classes
struct	StepInfo

Public Member Functions
void	register_log (StepInfo info)
f64	get_last_rate ()
u64	get_last_obj_count ()
shamsys::SystemMetrics	get_last_system_metrics ()
u64	get_iteration_count ()
f64	get_cumulated_step_time ()
void	reset_cumulated_step_time ()
u64	get_step_count ()
void	reset_step_count ()

Public Attributes
std::vector< StepInfo >	step_logs = {}
f64	cumulated_step_time = 0
u64	step_count = 0

Detailed Description

Class holding the logs of the solver /todo add a variable to keep only a definite number of steps in the step_logs.

Definition at line 34 of file SolverLog.hpp.

Member Function Documentation

get_cumulated_step_time()

f64 shammodels::SolverLog::get_cumulated_step_time ( )

inline

Definition at line 64 of file SolverLog.hpp.

get_iteration_count()

u64 shammodels::SolverLog::get_iteration_count ( )

inline

Definition at line 62 of file SolverLog.hpp.

get_last_obj_count()

u64 shammodels::SolverLog::get_last_obj_count

(

)

Definition at line 40 of file SolverLog.cpp.

get_last_rate()

f64 shammodels::SolverLog::get_last_rate

(

)

Definition at line 23 of file SolverLog.cpp.

get_last_system_metrics()

shamsys::SystemMetrics shammodels::SolverLog::get_last_system_metrics

(

)

Definition at line 55 of file SolverLog.cpp.

get_step_count()

u64 shammodels::SolverLog::get_step_count ( )

inline

Definition at line 68 of file SolverLog.hpp.

register_log()

void shammodels::SolverLog::register_log ( StepInfo info )

inline

Definition at line 52 of file SolverLog.hpp.

reset_cumulated_step_time()

void shammodels::SolverLog::reset_cumulated_step_time ( )

inline

Definition at line 66 of file SolverLog.hpp.

reset_step_count()

void shammodels::SolverLog::reset_step_count ( )

inline

Definition at line 69 of file SolverLog.hpp.

Member Data Documentation

cumulated_step_time

f64 shammodels::SolverLog::cumulated_step_time = 0

Definition at line 49 of file SolverLog.hpp.

step_count

u64 shammodels::SolverLog::step_count = 0

Definition at line 50 of file SolverLog.hpp.

step_logs

std::vector<StepInfo> shammodels::SolverLog::step_logs = {}

Definition at line 47 of file SolverLog.hpp.

---

The documentation for this struct was generated from the following files:

• shammodels/common/include/shammodels/common/SolverLog.hpp
• shammodels/common/src/SolverLog.cpp