/usr/share/doc/libwreport-doc/apidocs/structwreport_1_1benchmark_1_1Benchmark.html is in libwreport-doc 3.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 221 222 223 224 225 226 227 228 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libwreport: wreport::benchmark::Benchmark Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libwreport
 <span id="projectnumber">3.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacewreport.html">wreport</a></li><li class="navelem"><b>benchmark</b></li><li class="navelem"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html">Benchmark</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">wreport::benchmark::Benchmark Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for all benchmarks.
<a href="structwreport_1_1benchmark_1_1Benchmark.html#details">More...</a></p>
<p><code>#include <<a class="el" href="benchmark_8h_source.html">benchmark.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad8d716d332dad061ec3f4f6076f2186d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8d716d332dad061ec3f4f6076f2186d"></a>
 </td><td class="memItemRight" valign="bottom"><b>Benchmark</b> (const std::string &name)</td></tr>
<tr class="separator:ad8d716d332dad061ec3f4f6076f2186d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7c112b893d00eee628d21b8d159f359"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#aa7c112b893d00eee628d21b8d159f359">setup_main</a> ()</td></tr>
<tr class="memdesc:aa7c112b893d00eee628d21b8d159f359"><td class="mdescLeft"> </td><td class="mdescRight">Set up the environment for this benchmark. <a href="#aa7c112b893d00eee628d21b8d159f359">More...</a><br /></td></tr>
<tr class="separator:aa7c112b893d00eee628d21b8d159f359"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f6fcc2177b2a02fd337a330c4839b06"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#a0f6fcc2177b2a02fd337a330c4839b06">teardown_main</a> ()</td></tr>
<tr class="memdesc:a0f6fcc2177b2a02fd337a330c4839b06"><td class="mdescLeft"> </td><td class="mdescRight">Tear down the environment for this benchmark. <a href="#a0f6fcc2177b2a02fd337a330c4839b06">More...</a><br /></td></tr>
<tr class="separator:a0f6fcc2177b2a02fd337a330c4839b06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe930a1d9a64d10b080f467f27f0c4d3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#afe930a1d9a64d10b080f467f27f0c4d3">setup_iteration</a> ()</td></tr>
<tr class="memdesc:afe930a1d9a64d10b080f467f27f0c4d3"><td class="mdescLeft"> </td><td class="mdescRight">Set up the environment for an iteration of this benchmark. <a href="#afe930a1d9a64d10b080f467f27f0c4d3">More...</a><br /></td></tr>
<tr class="separator:afe930a1d9a64d10b080f467f27f0c4d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6863ab2529fc679808394654bdaaea35"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#a6863ab2529fc679808394654bdaaea35">teardown_iteration</a> ()</td></tr>
<tr class="memdesc:a6863ab2529fc679808394654bdaaea35"><td class="mdescLeft"> </td><td class="mdescRight">Tear down the environment for an iteration of this benchmark. <a href="#a6863ab2529fc679808394654bdaaea35">More...</a><br /></td></tr>
<tr class="separator:a6863ab2529fc679808394654bdaaea35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab19d63d53df89620eb548945fc01ee0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab19d63d53df89620eb548945fc01ee0d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#ab19d63d53df89620eb548945fc01ee0d">run</a> (<a class="el" href="structwreport_1_1benchmark_1_1Progress.html">Progress</a> &progress)</td></tr>
<tr class="memdesc:ab19d63d53df89620eb548945fc01ee0d"><td class="mdescLeft"> </td><td class="mdescRight">Run the benchmark and collect timings. <br /></td></tr>
<tr class="separator:ab19d63d53df89620eb548945fc01ee0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9385873764b0063dc7474f86ec362b20"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9385873764b0063dc7474f86ec362b20"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#a9385873764b0063dc7474f86ec362b20">print_timings</a> ()</td></tr>
<tr class="memdesc:a9385873764b0063dc7474f86ec362b20"><td class="mdescLeft"> </td><td class="mdescRight">Print timings to stdout. <br /></td></tr>
<tr class="separator:a9385873764b0063dc7474f86ec362b20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d77c417046578491515c3dbbaeb908c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d77c417046578491515c3dbbaeb908c"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1benchmark_1_1Benchmark.html#a5d77c417046578491515c3dbbaeb908c">main</a> ()=0</td></tr>
<tr class="memdesc:a5d77c417046578491515c3dbbaeb908c"><td class="mdescLeft"> </td><td class="mdescRight">Main body of this benchmark. <br /></td></tr>
<tr class="separator:a5d77c417046578491515c3dbbaeb908c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a59e134ef063f3719ec53da37a0965356"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59e134ef063f3719ec53da37a0965356"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
<tr class="separator:a59e134ef063f3719ec53da37a0965356"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa75fbd3c1a59ff62c88600550db236f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa75fbd3c1a59ff62c88600550db236f"></a>
unsigned </td><td class="memItemRight" valign="bottom"><b>repetitions</b> = 10</td></tr>
<tr class="separator:aaa75fbd3c1a59ff62c88600550db236f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fd300a42594992bee9fde7d32f3a2d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fd300a42594992bee9fde7d32f3a2d1"></a>
std::vector< <a class="el" href="structwreport_1_1benchmark_1_1Task.html">Task</a> * > </td><td class="memItemRight" valign="bottom"><b>tasks</b></td></tr>
<tr class="separator:a9fd300a42594992bee9fde7d32f3a2d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeda6aad79316fb268c41d69a1d329972"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeda6aad79316fb268c41d69a1d329972"></a>
<a class="el" href="structwreport_1_1benchmark_1_1Task.html">Task</a> </td><td class="memItemRight" valign="bottom"><b>task_main</b></td></tr>
<tr class="separator:aeda6aad79316fb268c41d69a1d329972"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for all benchmarks. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afe930a1d9a64d10b080f467f27f0c4d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wreport::benchmark::Benchmark::setup_iteration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up the environment for an iteration of this benchmark. </p>
<p>This is run outside of timings. By default it does nothing. </p>
</div>
</div>
<a class="anchor" id="aa7c112b893d00eee628d21b8d159f359"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wreport::benchmark::Benchmark::setup_main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up the environment for this benchmark. </p>
<p>This is run outside of timings. By default it does nothing. </p>
</div>
</div>
<a class="anchor" id="a6863ab2529fc679808394654bdaaea35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wreport::benchmark::Benchmark::teardown_iteration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tear down the environment for an iteration of this benchmark. </p>
<p>This is run outside of timings. By default it does nothing. </p>
</div>
</div>
<a class="anchor" id="a0f6fcc2177b2a02fd337a330c4839b06"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wreport::benchmark::Benchmark::teardown_main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tear down the environment for this benchmark. </p>
<p>This is run outside of timings. By default it does nothing. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="benchmark_8h_source.html">benchmark.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|