# Ipopt::TimingStatistics Class Reference

This class collects all timing statistics for Ipopt. More...

`#include <IpTimingStatistics.hpp>`

Inheritance diagram for Ipopt::TimingStatistics:
[legend]

List of all members.

## Public Member Functions
void | ResetTimes ()
| Method for resetting all times.
void | PrintAllTimingStatistics (Journalist &jnlst, EJournalLevel level, EJournalCategory category) const
| Method for printing all timing information.
Constructors/Destructors
| TimingStatistics ()
| Default constructor.
virtual | ~TimingStatistics ()
| Default destructor.
Accessor methods to all timed tasks.
TimedTask & | OverallAlgorithm ()
TimedTask & | PrintProblemStatistics ()
TimedTask & | InitializeIterates ()
TimedTask & | UpdateHessian ()
TimedTask & | OutputIteration ()
TimedTask & | UpdateBarrierParameter ()
TimedTask & | ComputeSearchDirection ()
TimedTask & | ComputeAcceptableTrialPoint ()
TimedTask & | AcceptTrialPoint ()
TimedTask & | CheckConvergence ()
TimedTask & | PDSystemSolverTotal ()
TimedTask & | PDSystemSolverSolveOnce ()
TimedTask & | ComputeResiduals ()
TimedTask & | StdAugSystemSolverMultiSolve ()
TimedTask & | LinearSystemScaling ()
TimedTask & | LinearSystemSymbolicFactorization ()
TimedTask & | LinearSystemFactorization ()
TimedTask & | LinearSystemBackSolve ()
TimedTask & | LinearSystemStructureConverter ()
TimedTask & | LinearSystemStructureConverterInit ()
TimedTask & | QualityFunctionSearch ()
TimedTask & | TryCorrector ()
TimedTask & | Task1 ()
TimedTask & | Task2 ()
TimedTask & | Task3 ()
TimedTask & | Task4 ()
TimedTask & | Task5 ()
TimedTask & | Task6 ()
## Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
| TimingStatistics (const TimingStatistics &)
| Copy Constructor.
void | operator= (const TimingStatistics &)
| Overloaded Equals Operator.
## Private Attributes
All timed tasks.
TimedTask | OverallAlgorithm_
TimedTask | PrintProblemStatistics_
TimedTask | InitializeIterates_
TimedTask | UpdateHessian_
TimedTask | OutputIteration_
TimedTask | UpdateBarrierParameter_
TimedTask | ComputeSearchDirection_
TimedTask | ComputeAcceptableTrialPoint_
TimedTask | AcceptTrialPoint_
TimedTask | CheckConvergence_
TimedTask | PDSystemSolverTotal_
TimedTask | PDSystemSolverSolveOnce_
TimedTask | ComputeResiduals_
TimedTask | StdAugSystemSolverMultiSolve_
TimedTask | LinearSystemScaling_
TimedTask | LinearSystemSymbolicFactorization_
TimedTask | LinearSystemFactorization_
TimedTask | LinearSystemBackSolve_
TimedTask | LinearSystemStructureConverter_
TimedTask | LinearSystemStructureConverterInit_
TimedTask | QualityFunctionSearch_
TimedTask | TryCorrector_
TimedTask | Task1_
TimedTask | Task2_
TimedTask | Task3_
TimedTask | Task4_
TimedTask | Task5_
TimedTask | Task6_

## Detailed Description

This class collects all timing statistics for Ipopt.

Definition at line 20 of file IpTimingStatistics.hpp.

## Constructor & Destructor Documentation

Ipopt::TimingStatistics::TimingStatistics | ( |  | ) | `[inline]`

Default constructor.

Definition at line 26 of file IpTimingStatistics.hpp.

virtual Ipopt::TimingStatistics::~TimingStatistics | ( |  | ) | `[inline, virtual]`

Default destructor.

Definition at line 30 of file IpTimingStatistics.hpp.

Ipopt::TimingStatistics::TimingStatistics | ( | const TimingStatistics & |  | ) | `[private]`

Copy Constructor.

## Member Function Documentation

void Ipopt::TimingStatistics::ResetTimes | ( |  | ) |

Method for resetting all times.

void Ipopt::TimingStatistics::PrintAllTimingStatistics | ( | Journalist & | jnlst,
|  | EJournalLevel | level,
|  | EJournalCategory | category |
| ) |  |  | const

Method for printing all timing information.

TimedTask& Ipopt::TimingStatistics::OverallAlgorithm | ( |  | ) | `[inline]`

Definition at line 44 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::PrintProblemStatistics | ( |  | ) | `[inline]`

Definition at line 48 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::InitializeIterates | ( |  | ) | `[inline]`

Definition at line 52 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::UpdateHessian | ( |  | ) | `[inline]`

Definition at line 56 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::OutputIteration | ( |  | ) | `[inline]`

Definition at line 60 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::UpdateBarrierParameter | ( |  | ) | `[inline]`

Definition at line 64 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::ComputeSearchDirection | ( |  | ) | `[inline]`

Definition at line 68 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::ComputeAcceptableTrialPoint | ( |  | ) | `[inline]`

Definition at line 72 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::AcceptTrialPoint | ( |  | ) | `[inline]`

Definition at line 76 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::CheckConvergence | ( |  | ) | `[inline]`

Definition at line 80 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::PDSystemSolverTotal | ( |  | ) | `[inline]`

Definition at line 85 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::PDSystemSolverSolveOnce | ( |  | ) | `[inline]`

Definition at line 89 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::ComputeResiduals | ( |  | ) | `[inline]`

Definition at line 93 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve | ( |  | ) | `[inline]`

Definition at line 97 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemScaling | ( |  | ) | `[inline]`

Definition at line 101 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemSymbolicFactorization | ( |  | ) | `[inline]`

Definition at line 105 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemFactorization | ( |  | ) | `[inline]`

Definition at line 109 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemBackSolve | ( |  | ) | `[inline]`

Definition at line 113 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemStructureConverter | ( |  | ) | `[inline]`

Definition at line 117 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::LinearSystemStructureConverterInit | ( |  | ) | `[inline]`

Definition at line 121 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::QualityFunctionSearch | ( |  | ) | `[inline]`

Definition at line 125 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::TryCorrector | ( |  | ) | `[inline]`

Definition at line 129 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task1 | ( |  | ) | `[inline]`

Definition at line 134 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task2 | ( |  | ) | `[inline]`

Definition at line 138 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task3 | ( |  | ) | `[inline]`

Definition at line 142 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task4 | ( |  | ) | `[inline]`

Definition at line 146 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task5 | ( |  | ) | `[inline]`

Definition at line 150 of file IpTimingStatistics.hpp.

TimedTask& Ipopt::TimingStatistics::Task6 | ( |  | ) | `[inline]`

Definition at line 154 of file IpTimingStatistics.hpp.

void Ipopt::TimingStatistics::operator= | ( | const TimingStatistics & |  | ) | `[private]`

Overloaded Equals Operator.

## Member Data Documentation

TimedTask Ipopt::TimingStatistics::OverallAlgorithm_`[private]`

Definition at line 178 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::PrintProblemStatistics_`[private]`

Definition at line 179 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::InitializeIterates_`[private]`

Definition at line 180 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::UpdateHessian_`[private]`

Definition at line 181 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::OutputIteration_`[private]`

Definition at line 182 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::UpdateBarrierParameter_`[private]`

Definition at line 183 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::ComputeSearchDirection_`[private]`

Definition at line 184 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::ComputeAcceptableTrialPoint_`[private]`

Definition at line 185 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::AcceptTrialPoint_`[private]`

Definition at line 186 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::CheckConvergence_`[private]`

Definition at line 187 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::PDSystemSolverTotal_`[private]`

Definition at line 189 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::PDSystemSolverSolveOnce_`[private]`

Definition at line 190 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::ComputeResiduals_`[private]`

Definition at line 191 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve_`[private]`

Definition at line 192 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemScaling_`[private]`

Definition at line 193 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemSymbolicFactorization_`[private]`

Definition at line 194 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemFactorization_`[private]`

Definition at line 195 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemBackSolve_`[private]`

Definition at line 196 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemStructureConverter_`[private]`

Definition at line 197 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::LinearSystemStructureConverterInit_`[private]`

Definition at line 198 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::QualityFunctionSearch_`[private]`

Definition at line 199 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::TryCorrector_`[private]`

Definition at line 200 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task1_`[private]`

Definition at line 202 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task2_`[private]`

Definition at line 203 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task3_`[private]`

Definition at line 204 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task4_`[private]`

Definition at line 205 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task5_`[private]`

Definition at line 206 of file IpTimingStatistics.hpp.

TimedTask Ipopt::TimingStatistics::Task6_`[private]`

Definition at line 207 of file IpTimingStatistics.hpp.

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

- src/Algorithm/IpTimingStatistics.hpp

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines