Ipopt  3.11.9
IpTimingStatistics.hpp
Go to the documentation of this file.
1 // Copyright (C) 2005, 2008 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpTimingStatistics.hpp 2005 2011-06-06 12:55:16Z stefan $
6 //
7 // Authors: Andreas Waechter IBM 2005-09-19
8 
9 #ifndef __IPTIMINGSTATISTICS_HPP__
10 #define __IPTIMINGSTATISTICS_HPP__
11 
12 #include "IpReferenced.hpp"
13 #include "IpJournalist.hpp"
14 #include "IpTimedTask.hpp"
15 
16 namespace Ipopt
17 {
21  {
22  public:
27  {}
28 
31  {}
33 
35  void ResetTimes();
36 
39  EJournalLevel level,
40  EJournalCategory category) const;
41 
45  {
46  return OverallAlgorithm_;
47  }
49  {
51  }
53  {
54  return InitializeIterates_;
55  }
57  {
58  return UpdateHessian_;
59  }
61  {
62  return OutputIteration_;
63  }
65  {
67  }
69  {
71  }
73  {
75  }
77  {
78  return AcceptTrialPoint_;
79  }
81  {
82  return CheckConvergence_;
83  }
84 
86  {
87  return PDSystemSolverTotal_;
88  }
90  {
92  }
94  {
95  return ComputeResiduals_;
96  }
98  {
100  }
102  {
103  return LinearSystemScaling_;
104  }
106  {
108  }
110  {
112  }
114  {
115  return LinearSystemBackSolve_;
116  }
118  {
120  }
122  {
124  }
126  {
127  return QualityFunctionSearch_;
128  }
130  {
131  return TryCorrector_;
132  }
133 
135  {
136  return Task1_;
137  }
139  {
140  return Task2_;
141  }
143  {
144  return Task3_;
145  }
147  {
148  return Task4_;
149  }
151  {
152  return Task5_;
153  }
155  {
156  return Task6_;
157  }
159 
160  private:
171 
173  void operator=(const TimingStatistics&);
175 
188 
201 
209  };
210 
211 } // namespace Ipopt
212 
213 #endif
Ipopt::TimingStatistics::OutputIteration_
TimedTask OutputIteration_
Definition: IpTimingStatistics.hpp:182
Ipopt::TimingStatistics::PDSystemSolverSolveOnce_
TimedTask PDSystemSolverSolveOnce_
Definition: IpTimingStatistics.hpp:190
Ipopt::TimingStatistics::QualityFunctionSearch
TimedTask & QualityFunctionSearch()
Definition: IpTimingStatistics.hpp:125
Ipopt::TimingStatistics::ComputeResiduals_
TimedTask ComputeResiduals_
Definition: IpTimingStatistics.hpp:191
Ipopt::TimingStatistics::LinearSystemSymbolicFactorization_
TimedTask LinearSystemSymbolicFactorization_
Definition: IpTimingStatistics.hpp:194
Ipopt::TimingStatistics::OverallAlgorithm
TimedTask & OverallAlgorithm()
Definition: IpTimingStatistics.hpp:44
Ipopt::TimingStatistics::TryCorrector_
TimedTask TryCorrector_
Definition: IpTimingStatistics.hpp:200
Ipopt::TimingStatistics::ResetTimes
void ResetTimes()
Method for resetting all times.
Ipopt::TimingStatistics::ComputeAcceptableTrialPoint_
TimedTask ComputeAcceptableTrialPoint_
Definition: IpTimingStatistics.hpp:185
Ipopt::TimingStatistics::LinearSystemScaling
TimedTask & LinearSystemScaling()
Definition: IpTimingStatistics.hpp:101
Ipopt::TimingStatistics::UpdateBarrierParameter
TimedTask & UpdateBarrierParameter()
Definition: IpTimingStatistics.hpp:64
Ipopt::TimingStatistics
This class collects all timing statistics for Ipopt.
Definition: IpTimingStatistics.hpp:20
Ipopt::TimingStatistics::LinearSystemBackSolve
TimedTask & LinearSystemBackSolve()
Definition: IpTimingStatistics.hpp:113
Ipopt::TimingStatistics::LinearSystemSymbolicFactorization
TimedTask & LinearSystemSymbolicFactorization()
Definition: IpTimingStatistics.hpp:105
Ipopt::TimingStatistics::LinearSystemScaling_
TimedTask LinearSystemScaling_
Definition: IpTimingStatistics.hpp:193
Ipopt::TimingStatistics::QualityFunctionSearch_
TimedTask QualityFunctionSearch_
Definition: IpTimingStatistics.hpp:199
Ipopt::TimingStatistics::InitializeIterates_
TimedTask InitializeIterates_
Definition: IpTimingStatistics.hpp:180
Ipopt::TimingStatistics::Task2_
TimedTask Task2_
Definition: IpTimingStatistics.hpp:203
Ipopt
Definition: matlabjournal.hpp:14
Ipopt::TimingStatistics::OverallAlgorithm_
TimedTask OverallAlgorithm_
Definition: IpTimingStatistics.hpp:178
Ipopt::TimingStatistics::Task6_
TimedTask Task6_
Definition: IpTimingStatistics.hpp:207
IpJournalist.hpp
Ipopt::TimingStatistics::Task6
TimedTask & Task6()
Definition: IpTimingStatistics.hpp:154
Ipopt::TimingStatistics::ComputeSearchDirection
TimedTask & ComputeSearchDirection()
Definition: IpTimingStatistics.hpp:68
Ipopt::EJournalLevel
EJournalLevel
Print Level Enum.
Definition: IpJournalist.hpp:51
Ipopt::TimingStatistics::PrintProblemStatistics_
TimedTask PrintProblemStatistics_
Definition: IpTimingStatistics.hpp:179
Ipopt::TimingStatistics::ComputeSearchDirection_
TimedTask ComputeSearchDirection_
Definition: IpTimingStatistics.hpp:184
Ipopt::TimingStatistics::PDSystemSolverSolveOnce
TimedTask & PDSystemSolverSolveOnce()
Definition: IpTimingStatistics.hpp:89
Ipopt::TimingStatistics::UpdateHessian_
TimedTask UpdateHessian_
Definition: IpTimingStatistics.hpp:181
Ipopt::TimingStatistics::CheckConvergence
TimedTask & CheckConvergence()
Definition: IpTimingStatistics.hpp:80
Ipopt::TimingStatistics::TryCorrector
TimedTask & TryCorrector()
Definition: IpTimingStatistics.hpp:129
Ipopt::TimingStatistics::LinearSystemStructureConverter
TimedTask & LinearSystemStructureConverter()
Definition: IpTimingStatistics.hpp:117
Ipopt::EJournalCategory
EJournalCategory
Category Selection Enum.
Definition: IpJournalist.hpp:70
Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve
TimedTask & StdAugSystemSolverMultiSolve()
Definition: IpTimingStatistics.hpp:97
Ipopt::TimingStatistics::AcceptTrialPoint
TimedTask & AcceptTrialPoint()
Definition: IpTimingStatistics.hpp:76
Ipopt::TimingStatistics::UpdateHessian
TimedTask & UpdateHessian()
Definition: IpTimingStatistics.hpp:56
Ipopt::TimingStatistics::PrintAllTimingStatistics
void PrintAllTimingStatistics(Journalist &jnlst, EJournalLevel level, EJournalCategory category) const
Method for printing all timing information.
Ipopt::TimingStatistics::Task3
TimedTask & Task3()
Definition: IpTimingStatistics.hpp:142
IpReferenced.hpp
Ipopt::TimingStatistics::OutputIteration
TimedTask & OutputIteration()
Definition: IpTimingStatistics.hpp:60
Ipopt::TimingStatistics::Task3_
TimedTask Task3_
Definition: IpTimingStatistics.hpp:204
Ipopt::TimingStatistics::LinearSystemFactorization
TimedTask & LinearSystemFactorization()
Definition: IpTimingStatistics.hpp:109
Ipopt::TimingStatistics::ComputeAcceptableTrialPoint
TimedTask & ComputeAcceptableTrialPoint()
Definition: IpTimingStatistics.hpp:72
Ipopt::TimingStatistics::~TimingStatistics
virtual ~TimingStatistics()
Default destructor.
Definition: IpTimingStatistics.hpp:30
Ipopt::TimingStatistics::TimingStatistics
TimingStatistics()
Default constructor.
Definition: IpTimingStatistics.hpp:26
Ipopt::TimingStatistics::AcceptTrialPoint_
TimedTask AcceptTrialPoint_
Definition: IpTimingStatistics.hpp:186
Ipopt::TimingStatistics::LinearSystemFactorization_
TimedTask LinearSystemFactorization_
Definition: IpTimingStatistics.hpp:195
Ipopt::TimingStatistics::UpdateBarrierParameter_
TimedTask UpdateBarrierParameter_
Definition: IpTimingStatistics.hpp:183
Ipopt::TimingStatistics::ComputeResiduals
TimedTask & ComputeResiduals()
Definition: IpTimingStatistics.hpp:93
Ipopt::TimingStatistics::Task5_
TimedTask Task5_
Definition: IpTimingStatistics.hpp:206
Ipopt::Journalist
Class responsible for all message output.
Definition: IpJournalist.hpp:134
Ipopt::TimingStatistics::InitializeIterates
TimedTask & InitializeIterates()
Definition: IpTimingStatistics.hpp:52
Ipopt::TimingStatistics::PDSystemSolverTotal_
TimedTask PDSystemSolverTotal_
Definition: IpTimingStatistics.hpp:189
Ipopt::TimingStatistics::LinearSystemStructureConverterInit
TimedTask & LinearSystemStructureConverterInit()
Definition: IpTimingStatistics.hpp:121
Ipopt::TimingStatistics::operator=
void operator=(const TimingStatistics &)
Overloaded Equals Operator.
IpTimedTask.hpp
Ipopt::TimingStatistics::LinearSystemStructureConverter_
TimedTask LinearSystemStructureConverter_
Definition: IpTimingStatistics.hpp:197
Ipopt::TimingStatistics::PrintProblemStatistics
TimedTask & PrintProblemStatistics()
Definition: IpTimingStatistics.hpp:48
Ipopt::TimingStatistics::Task4_
TimedTask Task4_
Definition: IpTimingStatistics.hpp:205
Ipopt::TimingStatistics::Task1
TimedTask & Task1()
Definition: IpTimingStatistics.hpp:134
Ipopt::TimedTask
This class is used to collect timing information for a particular task.
Definition: IpTimedTask.hpp:18
Ipopt::TimingStatistics::StdAugSystemSolverMultiSolve_
TimedTask StdAugSystemSolverMultiSolve_
Definition: IpTimingStatistics.hpp:192
Ipopt::TimingStatistics::LinearSystemStructureConverterInit_
TimedTask LinearSystemStructureConverterInit_
Definition: IpTimingStatistics.hpp:198
Ipopt::TimingStatistics::Task2
TimedTask & Task2()
Definition: IpTimingStatistics.hpp:138
Ipopt::TimingStatistics::PDSystemSolverTotal
TimedTask & PDSystemSolverTotal()
Definition: IpTimingStatistics.hpp:85
Ipopt::TimingStatistics::CheckConvergence_
TimedTask CheckConvergence_
Definition: IpTimingStatistics.hpp:187
Ipopt::TimingStatistics::Task1_
TimedTask Task1_
Definition: IpTimingStatistics.hpp:202
Ipopt::ReferencedObject
ReferencedObject class.
Definition: IpReferenced.hpp:174
Ipopt::TimingStatistics::Task4
TimedTask & Task4()
Definition: IpTimingStatistics.hpp:146
Ipopt::TimingStatistics::LinearSystemBackSolve_
TimedTask LinearSystemBackSolve_
Definition: IpTimingStatistics.hpp:196
Ipopt::TimingStatistics::Task5
TimedTask & Task5()
Definition: IpTimingStatistics.hpp:150