forked from DLR-SC/tigl-website
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathclasst8__partition__search__base.html
242 lines (228 loc) · 12.7 KB
/
classt8__partition__search__base.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
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>t8: t8_partition_search_base 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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">t8
 <span id="projectnumber">4.0.0-RC1.588-22cbd</span>
</div>
<div id="projectbrief">t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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: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-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">t8_partition_search_base Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for t8_partition_search_base:</div>
<div class="dyncontent">
<div class="center">
<img src="classt8__partition__search__base.png" usemap="#t8_5Fpartition_5Fsearch_5Fbase_map" alt=""/>
<map id="t8_5Fpartition_5Fsearch_5Fbase_map" name="t8_5Fpartition_5Fsearch_5Fbase_map">
<area href="classt8__partition__search.html" alt="t8_partition_search< void >" shape="rect" coords="187,56,551,80"/>
<area href="classt8__partition__search.html" alt="t8_partition_search< Udata >" shape="rect" coords="561,56,925,80"/>
<area href="classt8__partition__search__with__batched__queries.html" title="A class that performs a search in the partition of a forest with batched queries." alt="t8_partition_search_with_batched_queries< Query_T, Udata >" shape="rect" coords="0,112,364,136"/>
<area href="classt8__partition__search__with__queries.html" title="A class that performs a search in the partition of a forest with queries." alt="t8_partition_search_with_queries< Query_T, Udata >" shape="rect" coords="374,112,738,136"/>
</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:a8f5700daeb21faa6fbfdf7dcdabc425b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__partition__search__base.html#a8f5700daeb21faa6fbfdf7dcdabc425b">t8_partition_search_base</a> (<a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> forest=nullptr)</td></tr>
<tr class="memdesc:a8f5700daeb21faa6fbfdf7dcdabc425b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classt8__partition__search__base.html">t8_partition_search_base</a> class. <a href="classt8__partition__search__base.html#a8f5700daeb21faa6fbfdf7dcdabc425b">More...</a><br /></td></tr>
<tr class="separator:a8f5700daeb21faa6fbfdf7dcdabc425b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82b2b4955073beb2399a7374d8c253ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__partition__search__base.html#a82b2b4955073beb2399a7374d8c253ed">update_forest</a> (<a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> forest)</td></tr>
<tr class="memdesc:a82b2b4955073beb2399a7374d8c253ed"><td class="mdescLeft"> </td><td class="mdescRight">Update the forest for the search. <a href="classt8__partition__search__base.html#a82b2b4955073beb2399a7374d8c253ed">More...</a><br /></td></tr>
<tr class="separator:a82b2b4955073beb2399a7374d8c253ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac69731cbeff50961b5fc9de9c188a89e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__partition__search__base.html#ac69731cbeff50961b5fc9de9c188a89e">~t8_partition_search_base</a> ()</td></tr>
<tr class="memdesc:ac69731cbeff50961b5fc9de9c188a89e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the <a class="el" href="classt8__partition__search__base.html">t8_partition_search_base</a> class. <a href="classt8__partition__search__base.html#ac69731cbeff50961b5fc9de9c188a89e">More...</a><br /></td></tr>
<tr class="separator:ac69731cbeff50961b5fc9de9c188a89e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3214028d1616e172670ba860309fb2c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__partition__search__base.html#a3214028d1616e172670ba860309fb2c0">do_search</a> ()</td></tr>
<tr class="memdesc:a3214028d1616e172670ba860309fb2c0"><td class="mdescLeft"> </td><td class="mdescRight">Perform the search. <a href="classt8__partition__search__base.html#a3214028d1616e172670ba860309fb2c0">More...</a><br /></td></tr>
<tr class="separator:a3214028d1616e172670ba860309fb2c0"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:af62fb6dbb5b0bab97d10a3a59e2a3c3c"><td class="memItemLeft" align="right" valign="top"><a id="af62fb6dbb5b0bab97d10a3a59e2a3c3c"></a>
<a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> </td><td class="memItemRight" valign="bottom"><b>forest</b></td></tr>
<tr class="separator:af62fb6dbb5b0bab97d10a3a59e2a3c3c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8f5700daeb21faa6fbfdf7dcdabc425b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f5700daeb21faa6fbfdf7dcdabc425b">◆ </a></span>t8_partition_search_base()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">t8_partition_search_base::t8_partition_search_base </td>
<td>(</td>
<td class="paramtype"><a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> </td>
<td class="paramname"><em>forest</em> = <code>nullptr</code></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>Constructor for the <a class="el" href="classt8__partition__search__base.html">t8_partition_search_base</a> class. </p>
<p>This constructor initializes a <a class="el" href="classt8__partition__search__base.html">t8_partition_search_base</a> object with the given forest. If the forest is not null, it increments the reference count of the forest and asserts that the forest is committed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">forest</td><td>A pointer to a t8_forest_t object. Defaults to nullptr. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac69731cbeff50961b5fc9de9c188a89e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac69731cbeff50961b5fc9de9c188a89e">◆ </a></span>~t8_partition_search_base()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">t8_partition_search_base::~t8_partition_search_base </td>
<td>(</td>
<td class="paramname"></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>Destructor for the <a class="el" href="classt8__partition__search__base.html">t8_partition_search_base</a> class. </p>
<p>This destructor decrements the reference count of the forest if it is not null. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3214028d1616e172670ba860309fb2c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3214028d1616e172670ba860309fb2c0">◆ </a></span>do_search()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void t8_partition_search_base::do_search </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform the search. </p>
<p>This function performs the search in the forest. </p>
</div>
</div>
<a id="a82b2b4955073beb2399a7374d8c253ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82b2b4955073beb2399a7374d8c253ed">◆ </a></span>update_forest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void t8_partition_search_base::update_forest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> </td>
<td class="paramname"><em>forest</em></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>Update the forest for the search. </p>
<p>This function updates the forest for the search. If the current forest is not null, it decrements the reference count of the forest. It then asserts that the new forest is not null and is committed. Finally, it increments the reference count of the new forest.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">forest</td><td>A pointer to a t8_forest_t object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/t8_forest/t8_forest_search/<a class="el" href="t8__forest__search_8hxx_source.html">t8_forest_search.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
</body>
</html>