Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1aggregate__progress.html

292 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::aggregate_progress&lt; T &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1aggregate__progress.html">aggregate_progress</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1aggregate__progress-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::aggregate_progress&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Aggregated progress indicator.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="progress_8hpp_source.html">stdex/progress.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1aggregate__progress_1_1worker__progress.html">worker_progress</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Progress indicator for individual worker. <a href="classstdex_1_1aggregate__progress_1_1worker__progress.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae832067bbc39765c8e53c2f6434f885a" id="r_ae832067bbc39765c8e53c2f6434f885a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae832067bbc39765c8e53c2f6434f885a">aggregate_progress</a> (size_t num_workers, <a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *host=nullptr)</td></tr>
<tr class="memdesc:ae832067bbc39765c8e53c2f6434f885a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a progress indicator. <br /></td></tr>
<tr class="separator:ae832067bbc39765c8e53c2f6434f885a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f41de4cbad813446edd060bea1e92f2" id="r_a4f41de4cbad813446edd060bea1e92f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f41de4cbad813446edd060bea1e92f2">attach</a> (<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *host)</td></tr>
<tr class="memdesc:a4f41de4cbad813446edd060bea1e92f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to a host progress indicator. <br /></td></tr>
<tr class="separator:a4f41de4cbad813446edd060bea1e92f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acec6e7132735143aaee405948821803f" id="r_acec6e7132735143aaee405948821803f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acec6e7132735143aaee405948821803f">detach</a> ()</td></tr>
<tr class="memdesc:acec6e7132735143aaee405948821803f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detach host progress indicator. <br /></td></tr>
<tr class="separator:acec6e7132735143aaee405948821803f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a431650892bd6133b6c781cf33b1a5d24" id="r_a431650892bd6133b6c781cf33b1a5d24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a431650892bd6133b6c781cf33b1a5d24">operator[]</a> (size_t index)</td></tr>
<tr class="memdesc:a431650892bd6133b6c781cf33b1a5d24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns progress indicator for specific worker. <br /></td></tr>
<tr class="separator:a431650892bd6133b6c781cf33b1a5d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a00a56087ed2f7cd94a3e8dfe2c1e42d5" id="r_a00a56087ed2f7cd94a3e8dfe2c1e42d5"><td class="memItemLeft" align="right" valign="top"><a id="a00a56087ed2f7cd94a3e8dfe2c1e42d5" name="a00a56087ed2f7cd94a3e8dfe2c1e42d5"></a>
<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>m_host</b></td></tr>
<tr class="separator:a00a56087ed2f7cd94a3e8dfe2c1e42d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ce9c164a861f96c3b297f1cb23138e" id="r_af6ce9c164a861f96c3b297f1cb23138e"><td class="memItemLeft" align="right" valign="top"><a id="af6ce9c164a861f96c3b297f1cb23138e" name="af6ce9c164a861f96c3b297f1cb23138e"></a>
std::atomic&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_start</b></td></tr>
<tr class="separator:af6ce9c164a861f96c3b297f1cb23138e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a3097047858bed0da70b0895f9e2a70" id="r_a7a3097047858bed0da70b0895f9e2a70"><td class="memItemLeft" align="right" valign="top"><a id="a7a3097047858bed0da70b0895f9e2a70" name="a7a3097047858bed0da70b0895f9e2a70"></a>
std::atomic&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_end</b></td></tr>
<tr class="separator:a7a3097047858bed0da70b0895f9e2a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5f44699c39950fa6024ac3ac75e7c1d" id="r_ac5f44699c39950fa6024ac3ac75e7c1d"><td class="memItemLeft" align="right" valign="top"><a id="ac5f44699c39950fa6024ac3ac75e7c1d" name="ac5f44699c39950fa6024ac3ac75e7c1d"></a>
std::atomic&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_value</b></td></tr>
<tr class="separator:ac5f44699c39950fa6024ac3ac75e7c1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6269b00cc116b23533e9539745da838f" id="r_a6269b00cc116b23533e9539745da838f"><td class="memItemLeft" align="right" valign="top"><a id="a6269b00cc116b23533e9539745da838f" name="a6269b00cc116b23533e9539745da838f"></a>
std::vector&lt; <a class="el" href="classstdex_1_1aggregate__progress_1_1worker__progress.html">worker_progress</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_workers</b></td></tr>
<tr class="separator:a6269b00cc116b23533e9539745da838f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3c372abda00bccee89b5c9838a86cc" id="r_a8d3c372abda00bccee89b5c9838a86cc"><td class="memItemLeft" align="right" valign="top"><a id="a8d3c372abda00bccee89b5c9838a86cc" name="a8d3c372abda00bccee89b5c9838a86cc"></a>
std::shared_mutex&#160;</td><td class="memItemRight" valign="bottom"><b>m_mutex</b></td></tr>
<tr class="separator:a8d3c372abda00bccee89b5c9838a86cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
class stdex::aggregate_progress&lt; T &gt;</div><p>Aggregated progress indicator. </p>
<p>Use to report combined progress from multiple workers. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae832067bbc39765c8e53c2f6434f885a" name="ae832067bbc39765c8e53c2f6434f885a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae832067bbc39765c8e53c2f6434f885a">&#9670;&#160;</a></span>aggregate_progress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::aggregate_progress </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>num_workers</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>host</em><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">num_workers</td><td>Total number of workers </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Host progress indicator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4f41de4cbad813446edd060bea1e92f2" name="a4f41de4cbad813446edd060bea1e92f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f41de4cbad813446edd060bea1e92f2">&#9670;&#160;</a></span>attach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>host</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach to a host progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Host progress indicator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acec6e7132735143aaee405948821803f" name="acec6e7132735143aaee405948821803f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acec6e7132735143aaee405948821803f">&#9670;&#160;</a></span>detach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; * <a class="el" href="classstdex_1_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::detach </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach host progress indicator. </p>
<dl class="section return"><dt>Returns</dt><dd>Old host progress indicator </dd></dl>
</div>
</div>
<a id="a431650892bd6133b6c781cf33b1a5d24" name="a431650892bd6133b6c781cf33b1a5d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a431650892bd6133b6c781cf33b1a5d24">&#9670;&#160;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; &amp; <a class="el" href="classstdex_1_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns progress indicator for specific worker. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of worker</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to specific worker progress indicator </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="progress_8hpp_source.html">progress.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Feb 12 2024 12:04:01 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink