- 3.0.2 optimal control module.
SummaryAllIterations< SCALAR > Struct Template Reference

#include <NLOCResults.hpp>

Public Member Functions

template<int NUM_PRECISION = 12>
void printSummaryLastIteration ()
 print summary of the last iteration with desired numeric precision More...
 
void logToMatlab (const std::string &fileName)
 

Public Attributes

std::vector< size_t > iterations
 log of the iterations More...
 
std::vector< SCALARdefect_l1_norms
 different overall defect norms More...
 
std::vector< SCALARdefect_l2_norms
 
std::vector< SCALARe_box_norms
 
std::vector< SCALARe_gen_norms
 
std::vector< SCALARlx_norms
 step update norms More...
 
std::vector< SCALARlu_norms
 
std::vector< SCALARintermediateCosts
 costs and merits More...
 
std::vector< SCALARfinalCosts
 
std::vector< SCALARtotalCosts
 
std::vector< SCALARmerits
 
std::vector< SCALARstepSizes
 step size More...
 
std::vector< SCALARsmallestEigenvalues
 smallest eigenvalues More...
 

Detailed Description

template<typename SCALAR = double>
struct SummaryAllIterations< SCALAR >

to do log every xth iter

Todo:
also log settings here
Examples:
LinearSystemTest.h.

Member Function Documentation

◆ printSummaryLastIteration()

template<typename SCALAR = double>
template<int NUM_PRECISION = 12>
void SummaryAllIterations< SCALAR >::printSummaryLastIteration ( )
inline

print summary of the last iteration with desired numeric precision

◆ logToMatlab()

template<typename SCALAR = double>
void SummaryAllIterations< SCALAR >::logToMatlab ( const std::string &  fileName)
inline

Member Data Documentation

◆ iterations

template<typename SCALAR = double>
std::vector<size_t> SummaryAllIterations< SCALAR >::iterations

log of the iterations

◆ defect_l1_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::defect_l1_norms

different overall defect norms

Referenced by ct::optcon::example::TEST().

◆ defect_l2_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::defect_l2_norms

◆ e_box_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::e_box_norms

◆ e_gen_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::e_gen_norms

◆ lx_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::lx_norms

step update norms

Referenced by ct::optcon::example::TEST().

◆ lu_norms

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::lu_norms

◆ intermediateCosts

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::intermediateCosts

costs and merits

◆ finalCosts

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::finalCosts

◆ totalCosts

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::totalCosts

◆ merits

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::merits

◆ stepSizes

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::stepSizes

step size

◆ smallestEigenvalues

template<typename SCALAR = double>
std::vector<SCALAR> SummaryAllIterations< SCALAR >::smallestEigenvalues

smallest eigenvalues


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