-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathstructbwOverlapIterator__t.html
280 lines (254 loc) · 13.3 KB
/
structbwOverlapIterator__t.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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libBigWig: bwOverlapIterator_t Struct 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">libBigWig
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">bwOverlapIterator_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure to hold iterations One of intervals and entries should be used to access records from bigWig or bigBed files, respectively.
<a href="structbwOverlapIterator__t.html#details">More...</a></p>
<p><code>#include <<a class="el" href="bigWig_8h_source.html">bigWig.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a93633b2c6c6dc1c1f3b26332924e5231"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbigWigFile__t.html">bigWigFile_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a93633b2c6c6dc1c1f3b26332924e5231">bw</a></td></tr>
<tr class="separator:a93633b2c6c6dc1c1f3b26332924e5231"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa10d193fe93d568d8caeabf33f96521"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#aaa10d193fe93d568d8caeabf33f96521">tid</a></td></tr>
<tr class="separator:aaa10d193fe93d568d8caeabf33f96521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f098ad832e134d457934df3d117e923"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a9f098ad832e134d457934df3d117e923">start</a></td></tr>
<tr class="separator:a9f098ad832e134d457934df3d117e923"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0f4d0bcb62d2e944a18a4a69e969ab6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#ab0f4d0bcb62d2e944a18a4a69e969ab6">end</a></td></tr>
<tr class="separator:ab0f4d0bcb62d2e944a18a4a69e969ab6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c34bec4eecfe96b84e7038b45b0433e"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a0c34bec4eecfe96b84e7038b45b0433e">offset</a></td></tr>
<tr class="separator:a0c34bec4eecfe96b84e7038b45b0433e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a401ea1885855ff8b4285fc289aa281cf"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a401ea1885855ff8b4285fc289aa281cf">blocksPerIteration</a></td></tr>
<tr class="separator:a401ea1885855ff8b4285fc289aa281cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a501db43c60eb9079a8484df3f769c9b5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a501db43c60eb9079a8484df3f769c9b5">withString</a></td></tr>
<tr class="separator:a501db43c60eb9079a8484df3f769c9b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2c02ec44c6c5a202874e79d9e2fca40"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#af2c02ec44c6c5a202874e79d9e2fca40">blocks</a></td></tr>
<tr class="separator:af2c02ec44c6c5a202874e79d9e2fca40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e1e6474d26a3e5900e6b91603e0664a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbwOverlappingIntervals__t.html">bwOverlappingIntervals_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a5e1e6474d26a3e5900e6b91603e0664a">intervals</a></td></tr>
<tr class="separator:a5e1e6474d26a3e5900e6b91603e0664a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43364e3fc0f4752d43a064a3bac801db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbbOverlappingEntries__t.html">bbOverlappingEntries_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a43364e3fc0f4752d43a064a3bac801db">entries</a></td></tr>
<tr class="separator:a43364e3fc0f4752d43a064a3bac801db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a897d7561ba0859a127b5f5713e3ff036"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbwOverlapIterator__t.html#a897d7561ba0859a127b5f5713e3ff036">data</a></td></tr>
<tr class="separator:a897d7561ba0859a127b5f5713e3ff036"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A structure to hold iterations One of intervals and entries should be used to access records from bigWig or bigBed files, respectively. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="af2c02ec44c6c5a202874e79d9e2fca40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2c02ec44c6c5a202874e79d9e2fca40">◆ </a></span>blocks</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* bwOverlapIterator_t::blocks</td>
</tr>
</table>
</div><div class="memdoc">
<p>Overlapping blocks. </p>
</div>
</div>
<a id="a401ea1885855ff8b4285fc289aa281cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a401ea1885855ff8b4285fc289aa281cf">◆ </a></span>blocksPerIteration</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bwOverlapIterator_t::blocksPerIteration</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of blocks to use per iteration. </p>
</div>
</div>
<a id="a93633b2c6c6dc1c1f3b26332924e5231"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93633b2c6c6dc1c1f3b26332924e5231">◆ </a></span>bw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbigWigFile__t.html">bigWigFile_t</a>* bwOverlapIterator_t::bw</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the bigWig/bigBed file. </p>
</div>
</div>
<a id="a897d7561ba0859a127b5f5713e3ff036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a897d7561ba0859a127b5f5713e3ff036">◆ </a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* bwOverlapIterator_t::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Points to either intervals or entries. If there are no further intervals/entries, then this is NULL. Use this to test for whether to continue iterating. </p>
</div>
</div>
<a id="ab0f4d0bcb62d2e944a18a4a69e969ab6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0f4d0bcb62d2e944a18a4a69e969ab6">◆ </a></span>end</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bwOverlapIterator_t::end</td>
</tr>
</table>
</div><div class="memdoc">
<p>End position of the query interval. </p>
</div>
</div>
<a id="a43364e3fc0f4752d43a064a3bac801db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43364e3fc0f4752d43a064a3bac801db">◆ </a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbbOverlappingEntries__t.html">bbOverlappingEntries_t</a>* bwOverlapIterator_t::entries</td>
</tr>
</table>
</div><div class="memdoc">
<p>Overlapping entries (or NULL). </p>
</div>
</div>
<a id="a5e1e6474d26a3e5900e6b91603e0664a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e1e6474d26a3e5900e6b91603e0664a">◆ </a></span>intervals</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbwOverlappingIntervals__t.html">bwOverlappingIntervals_t</a>* bwOverlapIterator_t::intervals</td>
</tr>
</table>
</div><div class="memdoc">
<p>Overlapping intervals (or NULL). </p>
</div>
</div>
<a id="a0c34bec4eecfe96b84e7038b45b0433e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c34bec4eecfe96b84e7038b45b0433e">◆ </a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bwOverlapIterator_t::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset into the blocks. </p>
</div>
</div>
<a id="a9f098ad832e134d457934df3d117e923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f098ad832e134d457934df3d117e923">◆ </a></span>start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bwOverlapIterator_t::start</td>
</tr>
</table>
</div><div class="memdoc">
<p>Start position of the query interval. </p>
</div>
</div>
<a id="aaa10d193fe93d568d8caeabf33f96521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa10d193fe93d568d8caeabf33f96521">◆ </a></span>tid</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bwOverlapIterator_t::tid</td>
</tr>
</table>
</div><div class="memdoc">
<p>The contig/chromosome ID. </p>
</div>
</div>
<a id="a501db43c60eb9079a8484df3f769c9b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a501db43c60eb9079a8484df3f769c9b5">◆ </a></span>withString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bwOverlapIterator_t::withString</td>
</tr>
</table>
</div><div class="memdoc">
<p>For bigBed entries, whether to return the string with the entries. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bigWig_8h_source.html">bigWig.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 8 2020 13:48:36 for libBigWig by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>