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
|
<!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"/>
<title>C Standard Library Extensions: cxtree.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">C Standard Library Extensions
 <span id="projectnumber">1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_c2959b2ad5731f3b356ab222d87e802c.html">cext</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">cxtree.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* $Id: cxtree.h,v 1.5 2011/02/21 14:15:31 rpalsa Exp $</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * This file is part of the ESO C Extension Library</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2001-2011 European Southern Observatory</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> * (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">/*</span>
<a name="l00022"></a>00022 <span class="comment"> * $Author: rpalsa $</span>
<a name="l00023"></a>00023 <span class="comment"> * $Date: 2011/02/21 14:15:31 $</span>
<a name="l00024"></a>00024 <span class="comment"> * $Revision: 1.5 $</span>
<a name="l00025"></a>00025 <span class="comment"> * $Name: cpl-6_1_1 $</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CX_TREE_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CX_TREE_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <cxmemory.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 CX_BEGIN_DECLS
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <span class="keyword">struct </span>_cx_tnode_ *cx_tree_iterator;
<a name="l00036"></a>00036 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keyword">struct </span>_cx_tnode_ *cx_tree_const_iterator;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct </span>_cx_tree_ cx_tree;
<a name="l00039"></a>00039
<a name="l00075"></a><a class="code" href="group__cxtree.html#ga9fe906309049ab24e407cd25fcd22f17">00075</a> <span class="keyword">typedef</span> cxbool (*<a class="code" href="group__cxtree.html#ga9fe906309049ab24e407cd25fcd22f17" title="The tree's key comparison operator function.">cx_tree_compare_func</a>)(cxcptr, cxcptr);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * Create, copy and destroy operations</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 cx_tree *<a class="code" href="group__cxtree.html#ga4d5b89c5e8709645b85996d05478d71e" title="Create a new tree without any elements.">cx_tree_new</a>(<a class="code" href="group__cxtree.html#ga9fe906309049ab24e407cd25fcd22f17" title="The tree's key comparison operator function.">cx_tree_compare_func</a>, cx_free_func, cx_free_func);
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#ga5e30a6c27e8e423d35a0818f264337fe" title="Destroy a tree and all its elements.">cx_tree_delete</a>(cx_tree *);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">/*</span>
<a name="l00085"></a>00085 <span class="comment"> * Nonmodifying operations</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 cxsize <a class="code" href="group__cxtree.html#ga3cc3eec66e54e3292d3354ffd2076696" title="Get the actual number of pairs in the tree.">cx_tree_size</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00089"></a>00089 cxbool <a class="code" href="group__cxtree.html#ga148c828066a5d05e95acd4ec3a525bc8" title="Check whether a tree is empty.">cx_tree_empty</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00090"></a>00090 cxsize <a class="code" href="group__cxtree.html#ga2a04a36bb3a449f14efa25e784169b57" title="Get the maximum number of pairs possible.">cx_tree_max_size</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00091"></a>00091 <a class="code" href="group__cxtree.html#ga9fe906309049ab24e407cd25fcd22f17" title="The tree's key comparison operator function.">cx_tree_compare_func</a> <a class="code" href="group__cxtree.html#ga40f1e3c1aff10f23fa128187f37f30ce" title="Get the key comparison function.">cx_tree_key_comp</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">/*</span>
<a name="l00094"></a>00094 <span class="comment"> * Special search operations</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a>00096
<a name="l00097"></a>00097 cxsize <a class="code" href="group__cxtree.html#gaede41b65d866b8c6cd7589bbebd81b39" title="Get the number of elements matching a key.">cx_tree_count</a>(<span class="keyword">const</span> cx_tree *, cxcptr);
<a name="l00098"></a>00098 cx_tree_iterator <a class="code" href="group__cxtree.html#gaa36076ac9467d17c8655a9a94a5f7a44" title="Locate an element in the tree.">cx_tree_find</a>(<span class="keyword">const</span> cx_tree *, cxcptr);
<a name="l00099"></a>00099 cx_tree_iterator <a class="code" href="group__cxtree.html#ga22e4896d6cd7486dc6d73eb7c3a56fea" title="Find the beginning of a subsequence.">cx_tree_lower_bound</a>(<span class="keyword">const</span> cx_tree *, cxcptr);
<a name="l00100"></a>00100 cx_tree_iterator <a class="code" href="group__cxtree.html#ga410dcaddb7845533076d98466f51c053" title="Find the end of a subsequence.">cx_tree_upper_bound</a>(<span class="keyword">const</span> cx_tree *, cxcptr);
<a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#ga9db4e043848ab20c0111b9a1b081593a" title="Find a subsequence matching a given key.">cx_tree_equal_range</a>(<span class="keyword">const</span> cx_tree *, cxcptr, cx_tree_iterator *,
<a name="l00102"></a>00102 cx_tree_iterator *);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">/*</span>
<a name="l00105"></a>00105 <span class="comment"> * Assignment operations</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#gaf79317c9c323f0d7b1903b7f23c1012e" title="Swap the contents of two trees.">cx_tree_swap</a>(cx_tree *, cx_tree *);
<a name="l00109"></a>00109 cxptr <a class="code" href="group__cxtree.html#ga5e47b9013eaeb6fe294e02d54a1e8cdf" title="Assign data to an iterator position.">cx_tree_assign</a>(cx_tree *, cx_tree_iterator, cxcptr);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">/*</span>
<a name="l00112"></a>00112 <span class="comment"> * Element access</span>
<a name="l00113"></a>00113 <span class="comment"> */</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115 cxptr <a class="code" href="group__cxtree.html#ga5578369c1a53b8592ff83032c6780cfb" title="Get the key from a given iterator position.">cx_tree_get_key</a>(<span class="keyword">const</span> cx_tree *, cx_tree_const_iterator);
<a name="l00116"></a>00116 cxptr <a class="code" href="group__cxtree.html#ga4b15b6abafbb4f528b5a1f0090b48f86" title="Get the data from a given iterator position.">cx_tree_get_value</a>(<span class="keyword">const</span> cx_tree *, cx_tree_const_iterator);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="comment">/*</span>
<a name="l00119"></a>00119 <span class="comment"> * Iterator functions</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121
<a name="l00122"></a>00122 cx_tree_iterator <a class="code" href="group__cxtree.html#ga6038e74547e7e3ac3280c519914b60a3" title="Get an iterator to the first pair in the tree.">cx_tree_begin</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00123"></a>00123 cx_tree_iterator <a class="code" href="group__cxtree.html#gadff64dc3840bb3d663e6b93b89e52d1e" title="Get an iterator for the position after the last pair in the tree.">cx_tree_end</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00124"></a>00124 cx_tree_iterator <a class="code" href="group__cxtree.html#ga86c1d604b075a32860f0f66cf678267c" title="Get an iterator for the next pair in the tree.">cx_tree_next</a>(<span class="keyword">const</span> cx_tree *, cx_tree_const_iterator);
<a name="l00125"></a>00125 cx_tree_iterator <a class="code" href="group__cxtree.html#ga7a7a6770d510c426f281fa9d46e1be5e" title="Get an iterator for the previous pair in the tree.">cx_tree_previous</a>(<span class="keyword">const</span> cx_tree *, cx_tree_const_iterator);
<a name="l00126"></a>00126
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="comment">/*</span>
<a name="l00129"></a>00129 <span class="comment"> * Inserting and removing elements</span>
<a name="l00130"></a>00130 <span class="comment"> */</span>
<a name="l00131"></a>00131
<a name="l00132"></a>00132 cx_tree_iterator <a class="code" href="group__cxtree.html#ga1f8f15e701fd1eb4ebe15639aea354e3" title="Attempt to insert data into a tree.">cx_tree_insert_unique</a>(cx_tree *, cxcptr, cxcptr);
<a name="l00133"></a>00133 cx_tree_iterator <a class="code" href="group__cxtree.html#ga07b038bf6018884fa92a5aa316e4cb66" title="Insert data into a tree.">cx_tree_insert_equal</a>(cx_tree *, cxcptr, cxcptr);
<a name="l00134"></a>00134 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#gaea5f45961ba5ab503c751f54810e8258" title="Erase an element from a tree.">cx_tree_erase_position</a>(cx_tree *, cx_tree_iterator);
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#gae573050dfd0d7cc829844609ff4a1dc2" title="Erase a range of elements from a tree.">cx_tree_erase_range</a>(cx_tree *, cx_tree_iterator, cx_tree_iterator);
<a name="l00136"></a>00136 cxsize <a class="code" href="group__cxtree.html#ga14027eafaeb3eaddd513b839672c5e92" title="Erase all elements from a tree matching the provided key.">cx_tree_erase</a>(cx_tree *, cxcptr);
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="group__cxtree.html#ga377e4c1587471733983f04707f8e619e" title="Remove all pairs from a tree.">cx_tree_clear</a>(cx_tree *);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/*</span>
<a name="l00140"></a>00140 <span class="comment"> * Debugging</span>
<a name="l00141"></a>00141 <span class="comment"> */</span>
<a name="l00142"></a>00142
<a name="l00143"></a>00143 cxbool <a class="code" href="group__cxtree.html#gaba9a431c2237e6b98584dd47052f8529" title="Validate a tree.">cx_tree_verify</a>(<span class="keyword">const</span> cx_tree *);
<a name="l00144"></a>00144
<a name="l00145"></a>00145 CX_END_DECLS
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="preprocessor">#endif </span><span class="comment">/* CX_TREE_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 22 2012 06:56:06 for C Standard Library Extensions by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>
</body>
</html>
|
