-
Notifications
You must be signed in to change notification settings - Fork 3
/
classAllReduceSockets.html
261 lines (255 loc) · 12.5 KB
/
classAllReduceSockets.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
258
259
260
261
<!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>Vowpal Wabbit: AllReduceSockets 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="https://github.com/JohnLangford/vowpal_wabbit/wiki"><span>Wiki</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</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="classAllReduceSockets-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AllReduceSockets Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <allreduce.h></code></p>
<div class="dynheader">
Inheritance diagram for AllReduceSockets:</div>
<div class="dyncontent">
<div class="center">
<img src="classAllReduceSockets.png" usemap="#AllReduceSockets_map" alt=""/>
<map id="AllReduceSockets_map" name="AllReduceSockets_map">
<area href="classAllReduce.html" alt="AllReduce" shape="rect" coords="0,0,114,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:a39d7eb04cefbf3d9f79bf81d4550c1a3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduceSockets.html#a39d7eb04cefbf3d9f79bf81d4550c1a3">AllReduceSockets</a> (std::string pspan_server, const int pport, const size_t punique_id, size_t ptotal, const size_t pnode, bool pquiet)</td></tr>
<tr class="separator:a39d7eb04cefbf3d9f79bf81d4550c1a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af224a5a5587c0679486f7b4ae2c9ac51"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAllReduceSockets.html#af224a5a5587c0679486f7b4ae2c9ac51">~AllReduceSockets</a> ()=default</td></tr>
<tr class="separator:af224a5a5587c0679486f7b4ae2c9ac51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c92f113271cb9d77859f594271f995f"><td class="memTemplParams" colspan="2">template<class T , void(*)(T &, const T &) f> </td></tr>
<tr class="memitem:a1c92f113271cb9d77859f594271f995f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classAllReduceSockets.html#a1c92f113271cb9d77859f594271f995f">all_reduce</a> (T *buffer, const size_t n)</td></tr>
<tr class="separator:a1c92f113271cb9d77859f594271f995f"><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 class="anchor" id="a39d7eb04cefbf3d9f79bf81d4550c1a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AllReduceSockets::AllReduceSockets </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>pspan_server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>pport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>punique_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>pquiet</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>
<a class="anchor" id="af224a5a5587c0679486f7b4ae2c9ac51"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AllReduceSockets::~AllReduceSockets </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 class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1c92f113271cb9d77859f594271f995f"></a>
<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 AllReduceSockets::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 Thu Nov 12 2020 14:25:59 for Vowpal Wabbit 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>