blob: 3cb129f872a07bdd9737dc66e8fa4aef0199664f [file] [log] [blame]
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Singa: /home/moaz/incubator-singa/include/singa/utils/timer.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">Apache Singa
</div>
<div id="projectbrief">A General Distributed Deep Learning Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_54125cd652f9635a64a4101de1b8704d.html">utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">timer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef SINGA_UTILS_TIMER_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SINGA_UTILS_TIMER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classsinga_1_1Timer.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Timer.html">Timer</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">typedef</span> std::chrono::duration&lt;int&gt; Seconds;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">typedef</span> std::chrono::duration&lt;int, std::milli&gt; Milliseconds;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">typedef</span> std::chrono::duration&lt;int, std::ratio&lt;60 * 60&gt;&gt; Hours;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">typedef</span> std::chrono::duration&lt;int, std::micro&gt; Microseconds;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classsinga_1_1Timer.html#a6cfa2e79d680a01774e1846ed0585b16"> 35</a></span>&#160; <a class="code" href="classsinga_1_1Timer.html#a6cfa2e79d680a01774e1846ed0585b16">Timer</a>() { <a class="code" href="classsinga_1_1Timer.html#a144cdf92b81d46823d1f179b14fabe0c">Tick</a>(); }</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classsinga_1_1Timer.html#a144cdf92b81d46823d1f179b14fabe0c"> 37</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Timer.html#a144cdf92b81d46823d1f179b14fabe0c">Tick</a>() { last_ = std::chrono::high_resolution_clock::now(); }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T = Milliseconds&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classsinga_1_1Timer.html#a57c7e3e0dc694917ecbbd6682fdc23d8"> 42</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1Timer.html#a57c7e3e0dc694917ecbbd6682fdc23d8">Elapsed</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; static_assert(std::is_same&lt;T, Seconds&gt;::value ||</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; std::is_same&lt;T, Milliseconds&gt;::value ||</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; std::is_same&lt;T, Hours&gt;::value ||</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; std::is_same&lt;T, Microseconds&gt;::value,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="stringliteral">&quot;Template arg must be Seconds | Milliseconds | Hours | Microseconds&quot;</span>);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">auto</span> now = std::chrono::high_resolution_clock::now();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> std::chrono::duration_cast&lt;T&gt;(now - last_).count();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// std::string CurrentTime();</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; std::chrono::high_resolution_clock::time_point last_;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;};</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classsinga_1_1Timer_html_a57c7e3e0dc694917ecbbd6682fdc23d8"><div class="ttname"><a href="classsinga_1_1Timer.html#a57c7e3e0dc694917ecbbd6682fdc23d8">singa::Timer::Elapsed</a></div><div class="ttdeci">int Elapsed() const</div><div class="ttdoc">Return the duration since last call to Tick() or since the creation of Timer. </div><div class="ttdef"><b>Definition:</b> timer.h:42</div></div>
<div class="ttc" id="classsinga_1_1Timer_html_a144cdf92b81d46823d1f179b14fabe0c"><div class="ttname"><a href="classsinga_1_1Timer.html#a144cdf92b81d46823d1f179b14fabe0c">singa::Timer::Tick</a></div><div class="ttdeci">void Tick()</div><div class="ttdoc">Reset the internal time point to the current time. </div><div class="ttdef"><b>Definition:</b> timer.h:37</div></div>
<div class="ttc" id="classsinga_1_1Timer_html_a6cfa2e79d680a01774e1846ed0585b16"><div class="ttname"><a href="classsinga_1_1Timer.html#a6cfa2e79d680a01774e1846ed0585b16">singa::Timer::Timer</a></div><div class="ttdeci">Timer()</div><div class="ttdoc">Init the internal time point to the current time. </div><div class="ttdef"><b>Definition:</b> timer.h:35</div></div>
<div class="ttc" id="classsinga_1_1Timer_html"><div class="ttname"><a href="classsinga_1_1Timer.html">singa::Timer</a></div><div class="ttdoc">For benchmarking the time cost of operations. </div><div class="ttdef"><b>Definition:</b> timer.h:27</div></div>
<div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>