robotoc
robotoc - efficient ROBOT Optimal Control solvers
Loading...
Searching...
No Matches
robotoc::SolverStatistics Class Reference

Statistics of optimal control solvers. More...

#include <solver_statistics.hpp>

Public Member Functions

void reserve (const int size)
 Reserves the data. More...
 
void clear ()
 Clear the all elements. More...
 
void disp (std::ostream &os) const
 Displays the solver statistics onto a ostream. More...
 

Public Attributes

bool convergence = false
 Flags whether the convergence is achieved. More...
 
int iter = 0
 Number of iterations until convergence. More...
 
std::vector< PerformanceIndexperformance_index
 Performance measurements at each iteration. More...
 
std::vector< double > primal_step_size
 Primal step sizes at each iteration. More...
 
std::vector< double > dual_step_size
 Dual step sizes at each iteration. More...
 
std::vector< std::deque< double > > ts
 Switching times at each iteration. More...
 
std::vector< int > mesh_refinement_iter
 Iterations where the mesh-refinements are carried out. More...
 
double cpu_time = 0
 CPU time is stored if SolverOptions::enable_benchmark is true. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const SolverStatistics &solver_statistics)
 

Detailed Description

Statistics of optimal control solvers.

Member Function Documentation

◆ clear()

void robotoc::SolverStatistics::clear ( )

Clear the all elements.

◆ disp()

void robotoc::SolverStatistics::disp ( std::ostream &  os) const

Displays the solver statistics onto a ostream.

◆ reserve()

void robotoc::SolverStatistics::reserve ( const int  size)

Reserves the data.

Parameters
[in]sizeSize of the new data.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const SolverStatistics solver_statistics 
)
friend

Member Data Documentation

◆ convergence

bool robotoc::SolverStatistics::convergence = false

Flags whether the convergence is achieved.

◆ cpu_time

double robotoc::SolverStatistics::cpu_time = 0

CPU time is stored if SolverOptions::enable_benchmark is true.

◆ dual_step_size

std::vector<double> robotoc::SolverStatistics::dual_step_size

Dual step sizes at each iteration.

◆ iter

int robotoc::SolverStatistics::iter = 0

Number of iterations until convergence.

◆ mesh_refinement_iter

std::vector<int> robotoc::SolverStatistics::mesh_refinement_iter

Iterations where the mesh-refinements are carried out.

◆ performance_index

std::vector<PerformanceIndex> robotoc::SolverStatistics::performance_index

Performance measurements at each iteration.

◆ primal_step_size

std::vector<double> robotoc::SolverStatistics::primal_step_size

Primal step sizes at each iteration.

◆ ts

std::vector<std::deque<double> > robotoc::SolverStatistics::ts

Switching times at each iteration.


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