forked from DLR-SC/tigl-website
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathclasst8__search.html
168 lines (163 loc) · 11.4 KB
/
classt8__search.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
<!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_search< Udata > Class Template 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_search< Udata > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for t8_search< Udata >:</div>
<div class="dyncontent">
<div class="center">
<img src="classt8__search.png" usemap="#t8_5Fsearch_3C_20Udata_20_3E_map" alt=""/>
<map id="t8_5Fsearch_3C_20Udata_20_3E_map" name="t8_5Fsearch_3C_20Udata_20_3E_map">
<area href="classt8__search__base.html" alt="t8_search_base" shape="rect" coords="0,0,124,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:aeeca2174a2729b79abd3ba21373acb9e"><td class="memItemLeft" align="right" valign="top"><a id="aeeca2174a2729b79abd3ba21373acb9e"></a>
 </td><td class="memItemRight" valign="bottom"><b>t8_search</b> (<a class="el" href="t8__forest__search_8hxx.html#a23309c560ae34e3da9e125fe949b197d">t8_search_element_callback</a>< Udata > element_callback, <a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> forest=nullptr, Udata *user_data=nullptr)</td></tr>
<tr class="separator:aeeca2174a2729b79abd3ba21373acb9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae56d782795b9440d7d9e140ba6bfb6a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__search.html#ae56d782795b9440d7d9e140ba6bfb6a7">update_user_data</a> (Udata *udata)</td></tr>
<tr class="memdesc:ae56d782795b9440d7d9e140ba6bfb6a7"><td class="mdescLeft"> </td><td class="mdescRight">Updates the user data associated with the object. <a href="classt8__search.html#ae56d782795b9440d7d9e140ba6bfb6a7">More...</a><br /></td></tr>
<tr class="separator:ae56d782795b9440d7d9e140ba6bfb6a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classt8__search__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classt8__search__base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classt8__search__base.html">t8_search_base</a></td></tr>
<tr class="memitem:a27d81c37cfbcdbb54015e2b8f17fe9ff inherit pub_methods_classt8__search__base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__search__base.html#a27d81c37cfbcdbb54015e2b8f17fe9ff">t8_search_base</a> (<a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> forest=nullptr)</td></tr>
<tr class="memdesc:a27d81c37cfbcdbb54015e2b8f17fe9ff inherit pub_methods_classt8__search__base"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classt8__search__base.html">t8_search_base</a> class. <a href="classt8__search__base.html#a27d81c37cfbcdbb54015e2b8f17fe9ff">More...</a><br /></td></tr>
<tr class="separator:a27d81c37cfbcdbb54015e2b8f17fe9ff inherit pub_methods_classt8__search__base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe8df0114d97d73660629ca747b66521 inherit pub_methods_classt8__search__base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__search__base.html#afe8df0114d97d73660629ca747b66521">update_forest</a> (<a class="el" href="t8__forest__general_8h.html#a8c66cd971abdb628a06dc8d9446b2f22">t8_forest_t</a> forest)</td></tr>
<tr class="memdesc:afe8df0114d97d73660629ca747b66521 inherit pub_methods_classt8__search__base"><td class="mdescLeft"> </td><td class="mdescRight">Update the forest for the search. <a href="classt8__search__base.html#afe8df0114d97d73660629ca747b66521">More...</a><br /></td></tr>
<tr class="separator:afe8df0114d97d73660629ca747b66521 inherit pub_methods_classt8__search__base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6975774f31ff854b1718263e61222354 inherit pub_methods_classt8__search__base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__search__base.html#a6975774f31ff854b1718263e61222354">~t8_search_base</a> ()</td></tr>
<tr class="memdesc:a6975774f31ff854b1718263e61222354 inherit pub_methods_classt8__search__base"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the <a class="el" href="classt8__search__base.html">t8_search_base</a> class. <a href="classt8__search__base.html#a6975774f31ff854b1718263e61222354">More...</a><br /></td></tr>
<tr class="separator:a6975774f31ff854b1718263e61222354 inherit pub_methods_classt8__search__base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac403938570e037962984a25617d88ba8 inherit pub_methods_classt8__search__base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__search__base.html#ac403938570e037962984a25617d88ba8">do_search</a> ()</td></tr>
<tr class="memdesc:ac403938570e037962984a25617d88ba8 inherit pub_methods_classt8__search__base"><td class="mdescLeft"> </td><td class="mdescRight">Perform the search. <a href="classt8__search__base.html#ac403938570e037962984a25617d88ba8">More...</a><br /></td></tr>
<tr class="separator:ac403938570e037962984a25617d88ba8 inherit pub_methods_classt8__search__base"><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:a3db515ed2fe252944ec5b28f9d3064da"><td class="memItemLeft" align="right" valign="top"><a id="a3db515ed2fe252944ec5b28f9d3064da"></a>
Udata * </td><td class="memItemRight" valign="bottom"><b>user_data</b></td></tr>
<tr class="separator:a3db515ed2fe252944ec5b28f9d3064da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_classt8__search__base"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classt8__search__base')"><img src="closed.png" alt="-"/> Data Fields inherited from <a class="el" href="classt8__search__base.html">t8_search_base</a></td></tr>
<tr class="memitem:a129e038c5dbbdf16b5cfac7019815355 inherit pub_attribs_classt8__search__base"><td class="memItemLeft" align="right" valign="top"><a id="a129e038c5dbbdf16b5cfac7019815355"></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:a129e038c5dbbdf16b5cfac7019815355 inherit pub_attribs_classt8__search__base"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae56d782795b9440d7d9e140ba6bfb6a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae56d782795b9440d7d9e140ba6bfb6a7">◆ </a></span>update_user_data()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Udata = void> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classt8__search.html">t8_search</a>< Udata >::update_user_data </td>
<td>(</td>
<td class="paramtype">Udata * </td>
<td class="paramname"><em>udata</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>Updates the user data associated with the object. </p>
<p>This function sets the user data pointer to the provided Udata object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>A pointer to the Udata object to be set as the user data. </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>