Ipopt Documentation  
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Ipopt::TimingStatistics Class Reference

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

#include <IpTimingStatistics.hpp>

+ Inheritance diagram for Ipopt::TimingStatistics:

Public Member Functions

bool IsFunctionEvaluationTimeEnabled () const
 Whether timing of function evaluation has been enabled.
 
Number TotalFunctionEvaluationCpuTime () const
 total CPU time spend in function evaluation
 
Number TotalFunctionEvaluationSysTime () const
 total system time spend in function evaluation
 
Number TotalFunctionEvaluationWallclockTime () const
 total wall-clock time spend in function evaluation
 
void ResetTimes ()
 Method for resetting all times.
 
void EnableTimes ()
 Method for enabling all timed tasked.
 
void DisableTimes ()
 Method for disabling all timed tasks except for OverallAlgorithm.
 
void PrintAllTimingStatistics (const Journalist &jnlst, EJournalLevel level, EJournalCategory category) const
 Method for printing all timing information.
 
Constructors/Destructors
 TimingStatistics ()
 Default constructor.
 
virtual ~TimingStatistics ()
 Destructor.
 
Accessor methods to all timed tasks.
TimedTask & OverallAlgorithm ()
 
const TimedTask & OverallAlgorithm () const
 
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 ()
 
TimedTask & f_eval_time ()
 
TimedTask & grad_f_eval_time ()
 
TimedTask & c_eval_time ()
 
TimedTask & jac_c_eval_time ()
 
TimedTask & d_eval_time ()
 
TimedTask & jac_d_eval_time ()
 
TimedTask & h_eval_time ()
 
- Public Member Functions inherited from Ipopt::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
Index ReferenceCount () const
 
void AddRef (const Referencer *referencer) const
 
void ReleaseRef (const Referencer *referencer) const
 

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 &)
 Default Assignment 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_
 
TimedTask f_eval_time_
 
TimedTask grad_f_eval_time_
 
TimedTask c_eval_time_
 
TimedTask jac_c_eval_time_
 
TimedTask d_eval_time_
 
TimedTask jac_d_eval_time_
 
TimedTask h_eval_time_
 

Detailed Description

This class collects all timing statistics for Ipopt.

Definition at line 18 of file IpTimingStatistics.hpp.

Constructor & Destructor Documentation

◆ TimingStatistics() [1/2]

Ipopt::TimingStatistics::TimingStatistics ( )
inline

Default constructor.

Definition at line 24 of file IpTimingStatistics.hpp.

◆ ~TimingStatistics()

virtual Ipopt::TimingStatistics::~TimingStatistics ( )
inlinevirtual

Destructor.

Definition at line 28 of file IpTimingStatistics.hpp.

◆ TimingStatistics() [2/2]

Ipopt::TimingStatistics::TimingStatistics ( const TimingStatistics &  )
private

Copy Constructor.

Member Function Documentation

◆ IsFunctionEvaluationTimeEnabled()

bool Ipopt::TimingStatistics::IsFunctionEvaluationTimeEnabled ( ) const

Whether timing of function evaluation has been enabled.

Since
3.14.0

◆ TotalFunctionEvaluationCpuTime()

Number Ipopt::TimingStatistics::TotalFunctionEvaluationCpuTime ( ) const

total CPU time spend in function evaluation

Since
3.14.0

◆ TotalFunctionEvaluationSysTime()

Number Ipopt::TimingStatistics::TotalFunctionEvaluationSysTime ( ) const

total system time spend in function evaluation

Since
3.14.0

◆ TotalFunctionEvaluationWallclockTime()

Number Ipopt::TimingStatistics::TotalFunctionEvaluationWallclockTime ( ) const

total wall-clock time spend in function evaluation

Since
3.14.0

◆ ResetTimes()

void Ipopt::TimingStatistics::ResetTimes ( )

Method for resetting all times.

◆ EnableTimes()

void Ipopt::TimingStatistics::EnableTimes ( )

Method for enabling all timed tasked.

Since
3.14.0

◆ DisableTimes()

void Ipopt::TimingStatistics::DisableTimes ( )

Method for disabling all timed tasks except for OverallAlgorithm.

Since
3.14.0

◆ PrintAllTimingStatistics()

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

Method for printing all timing information.

◆ OverallAlgorithm() [1/2]

TimedTask & Ipopt::TimingStatistics::OverallAlgorithm ( )
inline

Definition at line 67 of file IpTimingStatistics.hpp.

◆ OverallAlgorithm() [2/2]

const TimedTask & Ipopt::TimingStatistics::OverallAlgorithm ( ) const
inline
Since
3.14.0

Definition at line 73 of file IpTimingStatistics.hpp.

◆ PrintProblemStatistics()

TimedTask & Ipopt::TimingStatistics::PrintProblemStatistics ( )
inline

Definition at line 78 of file IpTimingStatistics.hpp.

◆ InitializeIterates()

TimedTask & Ipopt::TimingStatistics::InitializeIterates ( )
inline

Definition at line 83 of file IpTimingStatistics.hpp.

◆ UpdateHessian()

TimedTask & Ipopt::TimingStatistics::UpdateHessian ( )
inline

Definition at line 88 of file IpTimingStatistics.hpp.

◆ OutputIteration()

TimedTask & Ipopt::TimingStatistics::OutputIteration ( )
inline

Definition at line 93 of file IpTimingStatistics.hpp.

◆ UpdateBarrierParameter()

TimedTask & Ipopt::TimingStatistics::UpdateBarrierParameter ( )
inline

Definition at line 98 of file IpTimingStatistics.hpp.

◆ ComputeSearchDirection()

TimedTask & Ipopt::TimingStatistics::ComputeSearchDirection ( )
inline

Definition at line 103 of file IpTimingStatistics.hpp.

◆ ComputeAcceptableTrialPoint()

TimedTask & Ipopt::TimingStatistics::ComputeAcceptableTrialPoint ( )
inline

Definition at line 108 of file IpTimingStatistics.hpp.

◆ AcceptTrialPoint()

TimedTask & Ipopt::TimingStatistics::AcceptTrialPoint ( )
inline

Definition at line 113 of file IpTimingStatistics.hpp.

◆ CheckConvergence()

TimedTask & Ipopt::TimingStatistics::CheckConvergence ( )
inline

Definition at line 118 of file IpTimingStatistics.hpp.

◆ PDSystemSolverTotal()

TimedTask & Ipopt::TimingStatistics::PDSystemSolverTotal ( )
inline

Definition at line 123 of file IpTimingStatistics.hpp.

◆ PDSystemSolverSolveOnce()

TimedTask & Ipopt::TimingStatistics::PDSystemSolverSolveOnce ( )
inline

Definition at line 128 of file IpTimingStatistics.hpp.

◆ ComputeResiduals()

TimedTask & Ipopt::TimingStatistics::ComputeResiduals ( )
inline

Definition at line 133 of file IpTimingStatistics.hpp.

◆ StdAugSystemSolverMultiSolve()

TimedTask & Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve ( )
inline

Definition at line 138 of file IpTimingStatistics.hpp.

◆ LinearSystemScaling()

TimedTask & Ipopt::TimingStatistics::LinearSystemScaling ( )
inline

Definition at line 143 of file IpTimingStatistics.hpp.

◆ LinearSystemSymbolicFactorization()

TimedTask & Ipopt::TimingStatistics::LinearSystemSymbolicFactorization ( )
inline

Definition at line 148 of file IpTimingStatistics.hpp.

◆ LinearSystemFactorization()

TimedTask & Ipopt::TimingStatistics::LinearSystemFactorization ( )
inline

Definition at line 153 of file IpTimingStatistics.hpp.

◆ LinearSystemBackSolve()

TimedTask & Ipopt::TimingStatistics::LinearSystemBackSolve ( )
inline

Definition at line 158 of file IpTimingStatistics.hpp.

◆ LinearSystemStructureConverter()

TimedTask & Ipopt::TimingStatistics::LinearSystemStructureConverter ( )
inline

Definition at line 163 of file IpTimingStatistics.hpp.

◆ LinearSystemStructureConverterInit()

TimedTask & Ipopt::TimingStatistics::LinearSystemStructureConverterInit ( )
inline

Definition at line 168 of file IpTimingStatistics.hpp.

◆ QualityFunctionSearch()

TimedTask & Ipopt::TimingStatistics::QualityFunctionSearch ( )
inline

Definition at line 173 of file IpTimingStatistics.hpp.

◆ TryCorrector()

TimedTask & Ipopt::TimingStatistics::TryCorrector ( )
inline

Definition at line 178 of file IpTimingStatistics.hpp.

◆ Task1()

TimedTask & Ipopt::TimingStatistics::Task1 ( )
inline

Definition at line 183 of file IpTimingStatistics.hpp.

◆ Task2()

TimedTask & Ipopt::TimingStatistics::Task2 ( )
inline

Definition at line 188 of file IpTimingStatistics.hpp.

◆ Task3()

TimedTask & Ipopt::TimingStatistics::Task3 ( )
inline

Definition at line 193 of file IpTimingStatistics.hpp.

◆ Task4()

TimedTask & Ipopt::TimingStatistics::Task4 ( )
inline

Definition at line 198 of file IpTimingStatistics.hpp.

◆ Task5()

TimedTask & Ipopt::TimingStatistics::Task5 ( )
inline

Definition at line 203 of file IpTimingStatistics.hpp.

◆ Task6()

TimedTask & Ipopt::TimingStatistics::Task6 ( )
inline

Definition at line 208 of file IpTimingStatistics.hpp.

◆ f_eval_time()

TimedTask & Ipopt::TimingStatistics::f_eval_time ( )
inline
Since
3.14.0

Definition at line 214 of file IpTimingStatistics.hpp.

◆ grad_f_eval_time()

TimedTask & Ipopt::TimingStatistics::grad_f_eval_time ( )
inline
Since
3.14.0

Definition at line 220 of file IpTimingStatistics.hpp.

◆ c_eval_time()

TimedTask & Ipopt::TimingStatistics::c_eval_time ( )
inline
Since
3.14.0

Definition at line 226 of file IpTimingStatistics.hpp.

◆ jac_c_eval_time()

TimedTask & Ipopt::TimingStatistics::jac_c_eval_time ( )
inline
Since
3.14.0

Definition at line 232 of file IpTimingStatistics.hpp.

◆ d_eval_time()

TimedTask & Ipopt::TimingStatistics::d_eval_time ( )
inline
Since
3.14.0

Definition at line 238 of file IpTimingStatistics.hpp.

◆ jac_d_eval_time()

TimedTask & Ipopt::TimingStatistics::jac_d_eval_time ( )
inline
Since
3.14.0

Definition at line 244 of file IpTimingStatistics.hpp.

◆ h_eval_time()

TimedTask & Ipopt::TimingStatistics::h_eval_time ( )
inline
Since
3.14.0

Definition at line 250 of file IpTimingStatistics.hpp.

◆ operator=()

void Ipopt::TimingStatistics::operator= ( const TimingStatistics &  )
private

Default Assignment Operator.

Member Data Documentation

◆ OverallAlgorithm_

TimedTask Ipopt::TimingStatistics::OverallAlgorithm_
private

Definition at line 280 of file IpTimingStatistics.hpp.

◆ PrintProblemStatistics_

TimedTask Ipopt::TimingStatistics::PrintProblemStatistics_
private

Definition at line 281 of file IpTimingStatistics.hpp.

◆ InitializeIterates_

TimedTask Ipopt::TimingStatistics::InitializeIterates_
private

Definition at line 282 of file IpTimingStatistics.hpp.

◆ UpdateHessian_

TimedTask Ipopt::TimingStatistics::UpdateHessian_
private

Definition at line 283 of file IpTimingStatistics.hpp.

◆ OutputIteration_

TimedTask Ipopt::TimingStatistics::OutputIteration_
private

Definition at line 284 of file IpTimingStatistics.hpp.

◆ UpdateBarrierParameter_

TimedTask Ipopt::TimingStatistics::UpdateBarrierParameter_
private

Definition at line 285 of file IpTimingStatistics.hpp.

◆ ComputeSearchDirection_

TimedTask Ipopt::TimingStatistics::ComputeSearchDirection_
private

Definition at line 286 of file IpTimingStatistics.hpp.

◆ ComputeAcceptableTrialPoint_

TimedTask Ipopt::TimingStatistics::ComputeAcceptableTrialPoint_
private

Definition at line 287 of file IpTimingStatistics.hpp.

◆ AcceptTrialPoint_

TimedTask Ipopt::TimingStatistics::AcceptTrialPoint_
private

Definition at line 288 of file IpTimingStatistics.hpp.

◆ CheckConvergence_

TimedTask Ipopt::TimingStatistics::CheckConvergence_
private

Definition at line 289 of file IpTimingStatistics.hpp.

◆ PDSystemSolverTotal_

TimedTask Ipopt::TimingStatistics::PDSystemSolverTotal_
private

Definition at line 291 of file IpTimingStatistics.hpp.

◆ PDSystemSolverSolveOnce_

TimedTask Ipopt::TimingStatistics::PDSystemSolverSolveOnce_
private

Definition at line 292 of file IpTimingStatistics.hpp.

◆ ComputeResiduals_

TimedTask Ipopt::TimingStatistics::ComputeResiduals_
private

Definition at line 293 of file IpTimingStatistics.hpp.

◆ StdAugSystemSolverMultiSolve_

TimedTask Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve_
private

Definition at line 294 of file IpTimingStatistics.hpp.

◆ LinearSystemScaling_

TimedTask Ipopt::TimingStatistics::LinearSystemScaling_
private

Definition at line 295 of file IpTimingStatistics.hpp.

◆ LinearSystemSymbolicFactorization_

TimedTask Ipopt::TimingStatistics::LinearSystemSymbolicFactorization_
private

Definition at line 296 of file IpTimingStatistics.hpp.

◆ LinearSystemFactorization_

TimedTask Ipopt::TimingStatistics::LinearSystemFactorization_
private

Definition at line 297 of file IpTimingStatistics.hpp.

◆ LinearSystemBackSolve_

TimedTask Ipopt::TimingStatistics::LinearSystemBackSolve_
private

Definition at line 298 of file IpTimingStatistics.hpp.

◆ LinearSystemStructureConverter_

TimedTask Ipopt::TimingStatistics::LinearSystemStructureConverter_
private

Definition at line 299 of file IpTimingStatistics.hpp.

◆ LinearSystemStructureConverterInit_

TimedTask Ipopt::TimingStatistics::LinearSystemStructureConverterInit_
private

Definition at line 300 of file IpTimingStatistics.hpp.

◆ QualityFunctionSearch_

TimedTask Ipopt::TimingStatistics::QualityFunctionSearch_
private

Definition at line 301 of file IpTimingStatistics.hpp.

◆ TryCorrector_

TimedTask Ipopt::TimingStatistics::TryCorrector_
private

Definition at line 302 of file IpTimingStatistics.hpp.

◆ Task1_

TimedTask Ipopt::TimingStatistics::Task1_
private

Definition at line 304 of file IpTimingStatistics.hpp.

◆ Task2_

TimedTask Ipopt::TimingStatistics::Task2_
private

Definition at line 305 of file IpTimingStatistics.hpp.

◆ Task3_

TimedTask Ipopt::TimingStatistics::Task3_
private

Definition at line 306 of file IpTimingStatistics.hpp.

◆ Task4_

TimedTask Ipopt::TimingStatistics::Task4_
private

Definition at line 307 of file IpTimingStatistics.hpp.

◆ Task5_

TimedTask Ipopt::TimingStatistics::Task5_
private

Definition at line 308 of file IpTimingStatistics.hpp.

◆ Task6_

TimedTask Ipopt::TimingStatistics::Task6_
private

Definition at line 309 of file IpTimingStatistics.hpp.

◆ f_eval_time_

TimedTask Ipopt::TimingStatistics::f_eval_time_
private

Definition at line 311 of file IpTimingStatistics.hpp.

◆ grad_f_eval_time_

TimedTask Ipopt::TimingStatistics::grad_f_eval_time_
private

Definition at line 312 of file IpTimingStatistics.hpp.

◆ c_eval_time_

TimedTask Ipopt::TimingStatistics::c_eval_time_
private

Definition at line 313 of file IpTimingStatistics.hpp.

◆ jac_c_eval_time_

TimedTask Ipopt::TimingStatistics::jac_c_eval_time_
private

Definition at line 314 of file IpTimingStatistics.hpp.

◆ d_eval_time_

TimedTask Ipopt::TimingStatistics::d_eval_time_
private

Definition at line 315 of file IpTimingStatistics.hpp.

◆ jac_d_eval_time_

TimedTask Ipopt::TimingStatistics::jac_d_eval_time_
private

Definition at line 316 of file IpTimingStatistics.hpp.

◆ h_eval_time_

TimedTask Ipopt::TimingStatistics::h_eval_time_
private

Definition at line 317 of file IpTimingStatistics.hpp.

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