-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathclassAux_1_1LoggingTimer.html
More file actions
220 lines (185 loc) · 15.7 KB
/
Copy pathclassAux_1_1LoggingTimer.html
File metadata and controls
220 lines (185 loc) · 15.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Class LoggingTimer</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=fa2d15c4" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-treeview/bootstrap-treeview.min.css?v=8176a87d" />
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<script src="../_static/documentation_options.js?v=89fba709"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/bootstrap-treeview/bootstrap-treeview.min.js?v=6a1e96b4"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script src="../_static/particles.min.js"></script>
<script src="../_static/custom.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Class IntegerTag" href="classAux_1_1Parsing_1_1Impl_1_1IntegerTag.html" />
<link rel="prev" title="Class IncrementalUniformRandomSelector" href="classAux_1_1IncrementalUniformRandomSelector.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
</head><body>
<a href="https://github.com/networkit/networkit"
class="visible-desktop hidden-xs"><img style="position: absolute; width:auto; height: auto; max-width: 200px; top:
0px; right: 0; border: 0; z-index: 3;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a>
<div id="fancy-particles-small"></div>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div style="float:left;height:auto; line-height:30px;">
<div style="overflow:hidden; line-height:15px">
<span style="display:block">
<a style="text-decoration: none; padding-top: 19.5px; padding-left:15px; height:30px;" class="navbar-brand" href="https://networkit.github.io">
NetworKit</a>
</span>
<div style="font-size:9pt; clear:left;">Large-Scale Network Analysis</div>
</div>
</div>
</div>
<div id="main-nav" class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="https://networkit.github.io/get_started.html">Get Started</a></li>
<li><a href="../index.html">Documentation</a></li>
<li><a href="https://networkit.github.io/features.html">Features</a></li>
<li><a href="https://networkit.github.io/news.html">News</a></li>
<li><a href="https://networkit.github.io/publications.html">Publications</a></li>
<li><a href="https://networkit.github.io/networkit-day.html">NetworKit Day</a></li>
<li><a href="https://networkit.github.io/credits.html">Credits & References</a></li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul class="sidebar">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../python_api/modules.html">Python Documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="library_root.html">C++ Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="library_root.html#page-hierarchy">Page Hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="library_root.html#class-hierarchy">Class Hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="library_root.html#file-hierarchy">File Hierarchy</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="library_root.html#full-api">Full API</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="library_root.html#namespaces">Namespaces</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="library_root.html#classes-and-structs">Classes and Structs</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#enums">Enums</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#variables">Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#defines">Defines</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#typedefs">Typedefs</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#directories">Directories</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_root.html#pages">Pages</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../notebooks.html">Jupyter Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../DevGuide.html">Developer Guide</a></li>
</ul>
</ul>
<form action="../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="col-md-9 content">
<section id="class-loggingtimer">
<span id="exhale-class-classaux-1-1loggingtimer"></span><h1>Class LoggingTimer<a class="headerlink" href="#class-loggingtimer" title="Link to this heading">¶</a></h1>
<ul class="simple">
<li><p>Defined in <a class="reference internal" href="file_include_networkit_auxiliary_Timer.hpp.html#file-include-networkit-auxiliary-timer-hpp"><span class="std std-ref">File Timer.hpp</span></a></p></li>
</ul>
<section id="inheritance-relationships">
<h2>Inheritance Relationships<a class="headerlink" href="#inheritance-relationships" title="Link to this heading">¶</a></h2>
<section id="base-type">
<h3>Base Type<a class="headerlink" href="#base-type" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">Aux::Timer</span></code> (<a class="reference internal" href="classAux_1_1Timer.html#exhale-class-classaux-1-1timer"><span class="std std-ref">Class Timer</span></a>)</p></li>
</ul>
</section>
</section>
<section id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Link to this heading">¶</a></h2>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N3Aux12LoggingTimerE">
<span class="target" id="classAux_1_1LoggingTimer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LoggingTimer</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">Aux</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classAux_1_1Timer.html#_CPPv4N3Aux5TimerE" title="Aux::Timer"><span class="n"><span class="pre">Timer</span></span></a><a class="headerlink" href="#_CPPv4N3Aux12LoggingTimerE" title="Link to this definition">¶</a><br /></dt>
<dd><p>A timer for running time measurements within a scope.</p>
<p>Same as <a class="reference internal" href="classAux_1_1Timer.html#classAux_1_1Timer"><span class="std std-ref">Timer</span></a> but automatically starts on construction and report on destruction.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="n">Aux</span><span class="p">::</span><span class="n">ScopedTimer</span><span class="p">(</span><span class="s2">"Algorithm A"</span><span class="p">);</span> <span class="o">//</span> <span class="n">WRONG</span><span class="p">;</span> <span class="n">will</span> <span class="n">directly</span> <span class="n">report</span> <span class="n">without</span> <span class="n">measuring</span> <span class="n">the</span> <span class="n">scope</span>
<span class="n">Aux</span><span class="p">::</span><span class="n">ScopedTimer</span> <span class="n">someName</span><span class="p">(</span><span class="s2">"Algorithm B"</span><span class="p">);</span> <span class="o">//</span> <span class="n">OK</span><span class="p">:</span> <span class="n">the</span> <span class="n">named</span> <span class="n">instance</span> <span class="ow">is</span> <span class="n">valid</span> <span class="n">until</span> <span class="n">the</span> <span class="n">end</span> <span class="n">of</span>
<span class="n">the</span> <span class="n">scope</span>
<span class="o">//</span> <span class="n">some</span> <span class="n">expensive</span> <span class="n">operations</span>
<span class="p">}</span> <span class="o">//</span> <span class="o"><-</span> <span class="n">Report</span> <span class="n">time</span> <span class="n">since</span> <span class="n">creation</span> <span class="n">of</span> <span class="n">the</span> <span class="n">timer</span> <span class="nb">object</span> <span class="n">via</span> <span class="n">Aux</span><span class="p">::</span><span class="n">Log</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>As the timer exploits RAII, it requires a named instance to extend its life time until the end of the current scope. In the example above “someName” is used. If the time measured seems too short, make you created a named instances. </p>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3Aux12LoggingTimer12LoggingTimerENSt11string_viewEN3Aux3Log8LogLevelE">
<span class="target" id="classAux_1_1LoggingTimer_1a4855940b71811cf3d080db8af779d05b"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LoggingTimer</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">label</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span>, <span class="n"><span class="pre">Aux</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Log</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="enum_Log_8hpp_1acc199e68524cfc007a14510c0693ee36.html#_CPPv4N3Aux3Log8LogLevelE" title="Aux::Log::LogLevel"><span class="n"><span class="pre">LogLevel</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">level</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">Aux</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Log</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="enum_Log_8hpp_1acc199e68524cfc007a14510c0693ee36.html#_CPPv4N3Aux3Log8LogLevelE" title="Aux::Log::LogLevel"><span class="n"><span class="pre">LogLevel</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="enum_Log_8hpp_1acc199e68524cfc007a14510c0693ee36.html#_CPPv4N3Aux3Log8LogLevel5DEBUGE" title="Aux::Log::LogLevel::DEBUG"><span class="n"><span class="pre">DEBUG</span></span></a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3Aux12LoggingTimer12LoggingTimerENSt11string_viewEN3Aux3Log8LogLevelE" title="Link to this definition">¶</a><br /></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>label</strong> – The label printed out next to the measurement </p></li>
<li><p><strong>level</strong> – Only measure if logging at the provided LogLevel is enabled during runtime. If logging at the given level is disable the <a class="reference internal" href="classAux_1_1Timer.html#classAux_1_1Timer"><span class="std std-ref">Timer</span></a> is very cheap to construct. If logging is disabled during construction or destruction, no message is shown. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3Aux12LoggingTimerD0Ev">
<span class="target" id="classAux_1_1LoggingTimer_1a5c5b04b0026179326540c63d3d1bc1c8"></span><span class="sig-name descname"><span class="n"><span class="pre">~LoggingTimer</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3Aux12LoggingTimerD0Ev" title="Link to this definition">¶</a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
</p>
<p style="float:left; max-width: 70%;">
© Copyright 2018 Humboldt-Universität zu Berlin - Department of Computer Science - Modeling and Analysis of Complex Systems and contributors.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 9.1.0.<br/>
</p>
<span style="padding-left: 10px">
<a href="https://networkit.github.io/contact.html">Contact, Imprint and Privacy</a>
</span>
</div>
</footer>
</body>
</html>