-
Notifications
You must be signed in to change notification settings - Fork 0
/
Stream_8h_source.html
147 lines (145 loc) · 12.8 KB
/
Stream_8h_source.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
<!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.5"/>
<title>isce3: isce/cxx/isce3/cuda/core/Stream.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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 style="padding-left: 0.5em;">
<div id="projectname">isce3
 <span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="sphinx/html/index.html"><span>Python classes</span></a></li>
<li><a href="https://github-fn.jpl.nasa.gov/isce-3/isce/issues/"><span>Issue Tracker</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="files.html"><span>File List</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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_404e96cc334514cbeb4d3a6830fc20a4.html">isce</a></li><li class="navelem"><a class="el" href="dir_242328b4dda42afcab822a3a2c9e5d23.html">cxx</a></li><li class="navelem"><a class="el" href="dir_25ad1bde3345b7504bdf331e9ef506fd.html">isce3</a></li><li class="navelem"><a class="el" href="dir_f4c25f90434c04f04bf31e4a71946cd1.html">cuda</a></li><li class="navelem"><a class="el" href="dir_3926dabc2bd3fc2ecb779799137698d2.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Stream.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "Event.h"</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span>isce3 { <span class="keyword">namespace </span>cuda { <span class="keyword">namespace </span>core {</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classisce3_1_1cuda_1_1core_1_1Stream.html"> 10</a></span> <span class="keyword">class </span><a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html">Stream</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html#aee67962a4a01fd591baa2acd311b1e7d">Stream</a>();</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html#aee67962a4a01fd591baa2acd311b1e7d">Stream</a>(std::nullptr_t);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classisce3_1_1cuda_1_1core_1_1Stream.html#a610ea1e2c03b19699e6c66d15ad1690e"> 22</a></span>  cudaStream_t <span class="keyword">get</span>() <span class="keyword">const</span> { <span class="keywordflow">return</span> *_stream; }</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">void</span> <a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html#afebf78e124588f3636d2ebebde65a5e4">record_event</a>(<a class="code" href="classisce3_1_1cuda_1_1core_1_1Event.html">Event</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classisce3_1_1cuda_1_1core_1_1Event.html">Event</a> <a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html#afebf78e124588f3636d2ebebde65a5e4">record_event</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> <a class="code" href="classisce3_1_1cuda_1_1core_1_1Stream.html#ae12a72238ef26d72136fcaa6444058aa">wait_event</a>(<a class="code" href="classisce3_1_1cuda_1_1core_1_1Event.html">Event</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::shared_ptr<cudaStream_t> _stream;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> };</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">bool</span> operator==(Stream, Stream);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">bool</span> operator!=(Stream, Stream);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> synchronize(Stream);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> query(Stream);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }}}</div>
<div class="ttc" id="classisce3_1_1cuda_1_1core_1_1Event_html"><div class="ttname"><a href="classisce3_1_1cuda_1_1core_1_1Event.html">isce3::cuda::core::Event</a></div><div class="ttdoc">Thin RAII wrapper around cudaEvent_t. </div><div class="ttdef"><b>Definition:</b> Event.h:8</div></div>
<div class="ttc" id="classisce3_1_1cuda_1_1core_1_1Stream_html_aee67962a4a01fd591baa2acd311b1e7d"><div class="ttname"><a href="classisce3_1_1cuda_1_1core_1_1Stream.html#aee67962a4a01fd591baa2acd311b1e7d">isce3::cuda::core::Stream::Stream</a></div><div class="ttdeci">Stream()</div><div class="ttdoc">Create an asynchronous stream object on the current CUDA device. </div></div>
<div class="ttc" id="classisce3_1_1cuda_1_1core_1_1Stream_html_afebf78e124588f3636d2ebebde65a5e4"><div class="ttname"><a href="classisce3_1_1cuda_1_1core_1_1Stream.html#afebf78e124588f3636d2ebebde65a5e4">isce3::cuda::core::Stream::record_event</a></div><div class="ttdeci">Event record_event() const </div><div class="ttdoc">Record an event to capture the contents of the stream. </div></div>
<div class="ttc" id="classisce3_1_1cuda_1_1core_1_1Stream_html_ae12a72238ef26d72136fcaa6444058aa"><div class="ttname"><a href="classisce3_1_1cuda_1_1core_1_1Stream.html#ae12a72238ef26d72136fcaa6444058aa">isce3::cuda::core::Stream::wait_event</a></div><div class="ttdeci">void wait_event(Event) const </div><div class="ttdoc">Wait for an event to complete. </div></div>
<div class="ttc" id="classisce3_1_1cuda_1_1core_1_1Stream_html"><div class="ttname"><a href="classisce3_1_1cuda_1_1core_1_1Stream.html">isce3::cuda::core::Stream</a></div><div class="ttdoc">Thin RAII wrapper around cudaStream_t. </div><div class="ttdef"><b>Definition:</b> Stream.h:10</div></div>
</div><!-- fragment --></div><!-- contents -->
<hr>
Generated for ISCE3.0 by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.5.
</body>
</html>