-
Notifications
You must be signed in to change notification settings - Fork 3
/
classAllReduceThreads.html
257 lines (246 loc) · 12.7 KB
/
classAllReduceThreads.html
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!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>Vowpal Wabbit: AllReduceThreads Class 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="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">Vowpal Wabbit
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classAllReduceThreads-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AllReduceThreads Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <allreduce.h></code></p>
<div class="dynheader">
Inheritance diagram for AllReduceThreads:</div>
<div class="dyncontent">
<div class="center">
<img src="classAllReduceThreads.png" usemap="#AllReduceThreads_map" alt=""/>
<map id="AllReduceThreads_map" name="AllReduceThreads_map">
<area href="classAllReduce.html" alt="AllReduce" shape="rect" coords="0,0,116,24"/>
</map>
</div></div>
<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:a55bf6976a5fb1cd2dc036b2899c29a07"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduceThreads.html#a55bf6976a5fb1cd2dc036b2899c29a07">AllReduceThreads</a> (<a class="el" href="classAllReduceThreads.html">AllReduceThreads</a> *root, const size_t ptotal, const size_t pnode, bool <a class="el" href="classAllReduce.html#a749a9bf84ad8da76c59351b538b6deba">quiet</a>=false)</td></tr>
<tr class="separator:a55bf6976a5fb1cd2dc036b2899c29a07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cccbdd0a46a186fd867529aa0f6c491"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduceThreads.html#a8cccbdd0a46a186fd867529aa0f6c491">AllReduceThreads</a> (const size_t ptotal, const size_t pnode, bool <a class="el" href="classAllReduce.html#a749a9bf84ad8da76c59351b538b6deba">quiet</a>=false)</td></tr>
<tr class="separator:a8cccbdd0a46a186fd867529aa0f6c491"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7aa5558412d4330b219b0b70e72102fb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduceThreads.html#a7aa5558412d4330b219b0b70e72102fb">~AllReduceThreads</a> ()</td></tr>
<tr class="separator:a7aa5558412d4330b219b0b70e72102fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96f28ae8e4d752d3f919c6a7ddaf27af"><td class="memTemplParams" colspan="2">template<class T , void(*)(T &, const T &) f> </td></tr>
<tr class="memitem:a96f28ae8e4d752d3f919c6a7ddaf27af"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classAllReduceThreads.html#a96f28ae8e4d752d3f919c6a7ddaf27af">all_reduce</a> (T *buffer, const size_t n)</td></tr>
<tr class="separator:a96f28ae8e4d752d3f919c6a7ddaf27af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classAllReduce"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAllReduce')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAllReduce.html">AllReduce</a></td></tr>
<tr class="memitem:a0bb9048bf8ec0a14718ad6bb7d6dbeca inherit pub_methods_classAllReduce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduce.html#a0bb9048bf8ec0a14718ad6bb7d6dbeca">AllReduce</a> (size_t ptotal, const size_t pnode, bool pquiet=false)</td></tr>
<tr class="separator:a0bb9048bf8ec0a14718ad6bb7d6dbeca inherit pub_methods_classAllReduce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7e150e60986a1abce4a7b20f06ea081 inherit pub_methods_classAllReduce"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduce.html#ad7e150e60986a1abce4a7b20f06ea081">~AllReduce</a> ()=default</td></tr>
<tr class="separator:ad7e150e60986a1abce4a7b20f06ea081 inherit pub_methods_classAllReduce"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classAllReduce"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classAllReduce')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classAllReduce.html">AllReduce</a></td></tr>
<tr class="memitem:a4ab695c1c631c3db42936d03733db9e0 inherit pub_attribs_classAllReduce"><td class="memItemLeft" align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduce.html#a4ab695c1c631c3db42936d03733db9e0">total</a></td></tr>
<tr class="separator:a4ab695c1c631c3db42936d03733db9e0 inherit pub_attribs_classAllReduce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabe2467446f88840299517725e20f84e inherit pub_attribs_classAllReduce"><td class="memItemLeft" align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduce.html#aabe2467446f88840299517725e20f84e">node</a></td></tr>
<tr class="separator:aabe2467446f88840299517725e20f84e inherit pub_attribs_classAllReduce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a749a9bf84ad8da76c59351b538b6deba inherit pub_attribs_classAllReduce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduce.html#a749a9bf84ad8da76c59351b538b6deba">quiet</a></td></tr>
<tr class="separator:a749a9bf84ad8da76c59351b538b6deba inherit pub_attribs_classAllReduce"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a55bf6976a5fb1cd2dc036b2899c29a07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55bf6976a5fb1cd2dc036b2899c29a07">◆ </a></span>AllReduceThreads() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AllReduceThreads::AllReduceThreads </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAllReduceThreads.html">AllReduceThreads</a> * </td>
<td class="paramname"><em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>ptotal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>pnode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>quiet</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8cccbdd0a46a186fd867529aa0f6c491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cccbdd0a46a186fd867529aa0f6c491">◆ </a></span>AllReduceThreads() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AllReduceThreads::AllReduceThreads </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>ptotal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>pnode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>quiet</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7aa5558412d4330b219b0b70e72102fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7aa5558412d4330b219b0b70e72102fb">◆ </a></span>~AllReduceThreads()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AllReduceThreads::~AllReduceThreads </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a96f28ae8e4d752d3f919c6a7ddaf27af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96f28ae8e4d752d3f919c6a7ddaf27af">◆ </a></span>all_reduce()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , void(*)(T &, const T &) f> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AllReduceThreads::all_reduce </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</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">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/<a class="el" href="allreduce_8h.html">allreduce.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 28 2022 20:01:54 for Vowpal Wabbit by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>