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
|
<!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: cxmap.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">cxmap.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* $Id: cxmap.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_MAP_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CX_MAP_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 <span class="preprocessor">#include <cxtree.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 CX_BEGIN_DECLS
<a name="l00035"></a>00035
<a name="l00046"></a><a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5">00046</a> <span class="keyword">typedef</span> cx_tree <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a>;
<a name="l00047"></a>00047
<a name="l00057"></a><a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b">00057</a> <span class="keyword">typedef</span> cx_tree_iterator <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a>;
<a name="l00058"></a>00058
<a name="l00069"></a><a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907">00069</a> <span class="keyword">typedef</span> cx_tree_const_iterator <a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907" title="The map constant iterator datatype.">cx_map_const_iterator</a>;
<a name="l00070"></a>00070
<a name="l00085"></a><a class="code" href="group__cxmap.html#ga9ee0926cc0122c3a915929dc8d436198">00085</a> <span class="keyword">typedef</span> <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__cxmap.html#ga9ee0926cc0122c3a915929dc8d436198" title="The map's key comparison operator function.">cx_map_compare_func</a>;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment"> * Create, copy and destroy operations</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *<a class="code" href="group__cxmap.html#ga6e539ee5ac510a3000d9984ce72d21f8" title="Create a new map without any elements.">cx_map_new</a>(cx_compare_func, cx_free_func, cx_free_func);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#ga94d7565c5fe50fec961d4f3f4fdbd241" title="Destroy a map and all its elements.">cx_map_delete</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">/*</span>
<a name="l00096"></a>00096 <span class="comment"> * Nonmodifying operations</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098
<a name="l00099"></a>00099 cxsize <a class="code" href="group__cxmap.html#ga307c8c94ef5f053f32fd3e2ba91d74c0" title="Get the actual number of pairs in the map.">cx_map_size</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00100"></a>00100 cxbool <a class="code" href="group__cxmap.html#gacd5d5b06a038b9746538291395432627" title="Check whether a map is empty.">cx_map_empty</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00101"></a>00101 cxsize <a class="code" href="group__cxmap.html#ga81cb88ef79b84e82c362b09a78319fbe" title="Get the maximum number of pairs possible.">cx_map_max_size</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00102"></a>00102 <a class="code" href="group__cxmap.html#ga9ee0926cc0122c3a915929dc8d436198" title="The map's key comparison operator function.">cx_map_compare_func</a> <a class="code" href="group__cxmap.html#ga4d8fbf9375ffab6b66ef27cbee11a015" title="Retrieve a map's key comparison function.">cx_map_key_comp</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">/*</span>
<a name="l00105"></a>00105 <span class="comment"> * Special search operations</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 cxsize <a class="code" href="group__cxmap.html#ga11cb14ad033e85525ded6dc92d093499" title="Get the number of elements matching a key.">cx_map_count</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00109"></a>00109 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#gaacefcf33145d47dcb9439c23b07be5fa" title="Locate an element in the map.">cx_map_find</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00110"></a>00110 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#ga75110aefe5bdddd1b3ab03d752d8e22b" title="Find the beginning of a subsequence matching a given key.">cx_map_lower_bound</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00111"></a>00111 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#gaa3cf57d1d4fc024a1d87dbae9807c209" title="Find the end of a subsequence matching a given key.">cx_map_upper_bound</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00112"></a>00112 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#ga61e396d53f3fe4f3a28f906e59e02dfb" title="Find a subsequence matching a given key.">cx_map_equal_range</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr, <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> *,
<a name="l00113"></a>00113 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> *);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment">/*</span>
<a name="l00116"></a>00116 <span class="comment"> * Assignment operations</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#gac480f53fd51f8e04b79ec92d1fe8e586" title="Swap the contents of two maps.">cx_map_swap</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00120"></a>00120 cxptr <a class="code" href="group__cxmap.html#ga80e8807a9c18e074bcac96a6477afb55" title="Assign data to an iterator position.">cx_map_assign</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a>, cxcptr);
<a name="l00121"></a>00121 cxptr <a class="code" href="group__cxmap.html#gaeb1c59ace3e10f9588616d0b9ea7fbfc" title="Set the value of a pair matching the given key.">cx_map_put</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr, cxcptr);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">/*</span>
<a name="l00124"></a>00124 <span class="comment"> * Element access</span>
<a name="l00125"></a>00125 <span class="comment"> */</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 cxptr <a class="code" href="group__cxmap.html#gaac55eccdca3ef107f4b76f5a7a57fca0" title="Get the key from a given iterator position.">cx_map_get_key</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907" title="The map constant iterator datatype.">cx_map_const_iterator</a>);
<a name="l00128"></a>00128 cxptr <a class="code" href="group__cxmap.html#gad6088581b6b73fd905bc37abffab2edf" title="Get the data from a given iterator position.">cx_map_get_value</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907" title="The map constant iterator datatype.">cx_map_const_iterator</a>);
<a name="l00129"></a>00129 cxptr <a class="code" href="group__cxmap.html#ga6dc8172e04dcf5589b00f1c6cc49207c" title="Get the data for a given key.">cx_map_get</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">/*</span>
<a name="l00132"></a>00132 <span class="comment"> * Iterator functions</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#ga156f4653538a24d512874a23213a2e1f" title="Get an iterator to the first pair in a map.">cx_map_begin</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00136"></a>00136 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#gae5dd15139b587d10b5cb7a15128b880e" title="Get an iterator for the position after the last pair in the map.">cx_map_end</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00137"></a>00137 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#ga0f33e89b70fefdb79b99467aba18587d" title="Get an iterator for the next pair in the map.">cx_map_next</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907" title="The map constant iterator datatype.">cx_map_const_iterator</a>);
<a name="l00138"></a>00138 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#ga6f6382072295b03f41686716486bb4d3" title="Get an iterator for the previous pair in the map.">cx_map_previous</a>(<span class="keyword">const</span> <a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#ga9e29bf978d1e595c8fedc6772e2ea907" title="The map constant iterator datatype.">cx_map_const_iterator</a>);
<a name="l00139"></a>00139
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">/*</span>
<a name="l00142"></a>00142 <span class="comment"> * Inserting and removing elements</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a> <a class="code" href="group__cxmap.html#gaaf6b77fe3fc775b2fc29bc435e6130b0" title="Attempt to insert data into a map.">cx_map_insert</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr, cxcptr);
<a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#ga3b5fb17aeafdff4b2cd5a660b06e80fe" title="Erase an element from a map.">cx_map_erase_position</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a>);
<a name="l00147"></a>00147 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#ga284d85c6de2206aaf7ff60a6667ce084" title="Erase a range of elements from a map.">cx_map_erase_range</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a>, <a class="code" href="group__cxmap.html#gac5294a05a8562fc04f1ba110a2e0717b" title="The map iterator datatype.">cx_map_iterator</a>);
<a name="l00148"></a>00148 cxsize <a class="code" href="group__cxmap.html#gae9a58e7a005280bdd0ba8a67b2c46c89" title="Erase an element from a map according to the provided key.">cx_map_erase</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *, cxcptr);
<a name="l00149"></a>00149 <span class="keywordtype">void</span> <a class="code" href="group__cxmap.html#gafe98264e8e9db4c0cfeba4561db37035" title="Remove all pairs from a map.">cx_map_clear</a>(<a class="code" href="group__cxmap.html#ga760f439b10c78131f1e2bfdba44edfd5" title="The map datatype.">cx_map</a> *);
<a name="l00150"></a>00150
<a name="l00151"></a>00151 CX_END_DECLS
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="preprocessor">#endif </span><span class="comment">/* CX_MAP_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>
|
