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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="raptor-section-sequence">
<refmeta>
<refentrytitle role="top_of_page">Sequence</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RAPTOR Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Sequence</refname>
<refpurpose>Ordered sequence of items.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="raptor-sequence">raptor_sequence</link>;
<link linkend="raptor-sequence">raptor_sequence</link>* <link linkend="raptor-new-sequence">raptor_new_sequence</link> (<link linkend="raptor-sequence-free-handler">raptor_sequence_free_handler</link> *free_handler,
<link linkend="raptor-sequence-print-handler">raptor_sequence_print_handler</link> *print_handler);
<link linkend="void">void</link> <link linkend="raptor-free-sequence">raptor_free_sequence</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq);
<link linkend="int">int</link> <link linkend="raptor-sequence-size">raptor_sequence_size</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq);
<link linkend="int">int</link> <link linkend="raptor-sequence-set-at">raptor_sequence_set_at</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> idx,
<link linkend="void">void</link> *data);
<link linkend="int">int</link> <link linkend="raptor-sequence-push">raptor_sequence_push</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="void">void</link> *data);
<link linkend="int">int</link> <link linkend="raptor-sequence-shift">raptor_sequence_shift</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="void">void</link> *data);
<link linkend="void">void</link>* <link linkend="raptor-sequence-get-at">raptor_sequence_get_at</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> idx);
<link linkend="void">void</link>* <link linkend="raptor-sequence-pop">raptor_sequence_pop</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq);
<link linkend="void">void</link>* <link linkend="raptor-sequence-unshift">raptor_sequence_unshift</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq);
<link linkend="int">int</link> <link linkend="raptor-compare-strings">raptor_compare_strings</link> (const <link linkend="void">void</link> *a,
const <link linkend="void">void</link> *b);
<link linkend="void">void</link> <link linkend="raptor-sequence-sort">raptor_sequence_sort</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> (*compare) (const void *, const void *));
<link linkend="void">void</link> <link linkend="raptor-sequence-print-string">raptor_sequence_print_string</link> (<link linkend="char">char</link> *data,
<link linkend="FILE:CAPS">FILE</link> *fh);
<link linkend="void">void</link> <link linkend="raptor-sequence-print-uri">raptor_sequence_print_uri</link> (<link linkend="char">char</link> *data,
<link linkend="FILE:CAPS">FILE</link> *fh);
<link linkend="void">void</link> <link linkend="raptor-sequence-set-print-handler">raptor_sequence_set_print_handler</link>
(<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="raptor-sequence-print-handler">raptor_sequence_print_handler</link> *print_handler);
<link linkend="void">void</link> <link linkend="raptor-sequence-print">raptor_sequence_print</link> (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="FILE:CAPS">FILE</link> *fh);
<link linkend="int">int</link> <link linkend="raptor-sequence-join">raptor_sequence_join</link> (<link linkend="raptor-sequence">raptor_sequence</link> *dest,
<link linkend="raptor-sequence">raptor_sequence</link> *src);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A utility class that provides access to small sequence of items
that grow at the end and require quick ordered and indexed access.
Can be used as a queue/FIFO but less efficiently than a stack
where the items are added and removed from the end.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="raptor-sequence" role="typedef"/>raptor_sequence</title>
<indexterm><primary>raptor_sequence</primary></indexterm><programlisting>raptor_sequence* raptor_sequence;
</programlisting>
<para>
Raptor sequence class</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="raptor-new-sequence" role="function"/>raptor_new_sequence ()</title>
<indexterm><primary>raptor_new_sequence</primary></indexterm><programlisting><link linkend="raptor-sequence">raptor_sequence</link>* raptor_new_sequence (<link linkend="raptor-sequence-free-handler">raptor_sequence_free_handler</link> *free_handler,
<link linkend="raptor-sequence-print-handler">raptor_sequence_print_handler</link> *print_handler);</programlisting>
<para>
Constructor - create a new sequence with the given handlers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>free_handler</parameter> :</term>
<listitem><simpara> handler to free a sequence item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>print_handler</parameter> :</term>
<listitem><simpara> handler to print a sequence item to a FILE*
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="raptor-sequence"><type>raptor_sequence</type></link> or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-free-sequence" role="function"/>raptor_free_sequence ()</title>
<indexterm><primary>raptor_free_sequence</primary></indexterm><programlisting><link linkend="void">void</link> raptor_free_sequence (<link linkend="raptor-sequence">raptor_sequence</link> *seq);</programlisting>
<para>
Destructor - free a <link linkend="raptor-sequence"><type>raptor_sequence</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to destroy
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-size" role="function"/>raptor_sequence_size ()</title>
<indexterm><primary>raptor_sequence_size</primary></indexterm><programlisting><link linkend="int">int</link> raptor_sequence_size (<link linkend="raptor-sequence">raptor_sequence</link> *seq);</programlisting>
<para>
Get the size of a sequence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the sequence size (>=0)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-set-at" role="function"/>raptor_sequence_set_at ()</title>
<indexterm><primary>raptor_sequence_set_at</primary></indexterm><programlisting><link linkend="int">int</link> raptor_sequence_set_at (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> idx,
<link linkend="void">void</link> *data);</programlisting>
<para>
Replace/set an item in a sequence.
</para>
<para>
The item at the offset <parameter>idx</parameter> in the sequence is replaced with the
new item <parameter>data</parameter> (which may be NULL). Any existing item is freed
with the sequence's free_handler.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>idx</parameter> :</term>
<listitem><simpara> index into sequence to operate at
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> new data item.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-push" role="function"/>raptor_sequence_push ()</title>
<indexterm><primary>raptor_sequence_push</primary></indexterm><programlisting><link linkend="int">int</link> raptor_sequence_push (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="void">void</link> *data);</programlisting>
<para>
Add an item to the end of the sequence.
</para>
<para>
This is efficient to perform. <link linkend="raptor-sequence"><type>raptor_sequence</type></link> is optimised
to append/remove from the end of the sequence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to add to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> item to add
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-shift" role="function"/>raptor_sequence_shift ()</title>
<indexterm><primary>raptor_sequence_shift</primary></indexterm><programlisting><link linkend="int">int</link> raptor_sequence_shift (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="void">void</link> *data);</programlisting>
<para>
Add an item to the start of the sequence.
</para>
<para>
This is in-efficient to perform. <link linkend="raptor-sequence"><type>raptor_sequence</type></link> is optimised
to append to the end of the sequence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to add to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> item to add
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-get-at" role="function"/>raptor_sequence_get_at ()</title>
<indexterm><primary>raptor_sequence_get_at</primary></indexterm><programlisting><link linkend="void">void</link>* raptor_sequence_get_at (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> idx);</programlisting>
<para>
Retrieve an item at offset <parameter>index</parameter> in the sequence.
</para>
<para>
This is efficient to perform. <link linkend="raptor-sequence"><type>raptor_sequence</type></link> is optimised
to append/remove from the end of the sequence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to use
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>idx</parameter> :</term>
<listitem><simpara> index of item to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object or NULL if <parameter>index</parameter> is out of range (0... sequence size-1)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-pop" role="function"/>raptor_sequence_pop ()</title>
<indexterm><primary>raptor_sequence_pop</primary></indexterm><programlisting><link linkend="void">void</link>* raptor_sequence_pop (<link linkend="raptor-sequence">raptor_sequence</link> *seq);</programlisting>
<para>
Retrieve the item at the end of the sequence.
</para>
<para>
This is efficient to perform.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to use
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object or NULL if the sequence is empty
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-unshift" role="function"/>raptor_sequence_unshift ()</title>
<indexterm><primary>raptor_sequence_unshift</primary></indexterm><programlisting><link linkend="void">void</link>* raptor_sequence_unshift (<link linkend="raptor-sequence">raptor_sequence</link> *seq);</programlisting>
<para>
Retrieve the item at the start of the sequence.
</para>
<para>
This is in-efficient to perform. <link linkend="raptor-sequence"><type>raptor_sequence</type></link> is optimised
to append/remove from the end of the sequence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to use
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object or NULL if the sequence is empty
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-compare-strings" role="function"/>raptor_compare_strings ()</title>
<indexterm><primary>raptor_compare_strings</primary></indexterm><programlisting><link linkend="int">int</link> raptor_compare_strings (const <link linkend="void">void</link> *a,
const <link linkend="void">void</link> *b);</programlisting>
<para>
Utility function for <link linkend="raptor-sequence-sort"><function>raptor_sequence_sort()</function></link> to compare a sequence of strings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara> pointer first string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara> pointer to second string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> comparison of <parameter>a</parameter> to <parameter>b</parameter> as strings
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-sort" role="function"/>raptor_sequence_sort ()</title>
<indexterm><primary>raptor_sequence_sort</primary></indexterm><programlisting><link linkend="void">void</link> raptor_sequence_sort (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="int">int</link> (*compare) (const void *, const void *));</programlisting>
<para>
The comparison function is compatible with that used for <link linkend="qsort"><function>qsort()</function></link>
and provides the addresses of pointers to the data that
must be dereferenced to get to the stored sequence data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to sort
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>compare</parameter> :</term>
<listitem><simpara> comparison function
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-print-string" role="function"/>raptor_sequence_print_string ()</title>
<indexterm><primary>raptor_sequence_print_string</primary></indexterm><programlisting><link linkend="void">void</link> raptor_sequence_print_string (<link linkend="char">char</link> *data,
<link linkend="FILE:CAPS">FILE</link> *fh);</programlisting>
<para>
Helper function for printing a sequence of strings.
</para>
<para>
Intended for use as a <link linkend="raptor-sequence-print-handler"><type>raptor_sequence_print_handler</type></link> passed into
<link linkend="raptor-new-sequence"><function>raptor_new_sequence()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> data item (a char*)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fh</parameter> :</term>
<listitem><simpara> file handle to print to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-print-uri" role="function"/>raptor_sequence_print_uri ()</title>
<indexterm><primary>raptor_sequence_print_uri</primary></indexterm><programlisting><link linkend="void">void</link> raptor_sequence_print_uri (<link linkend="char">char</link> *data,
<link linkend="FILE:CAPS">FILE</link> *fh);</programlisting>
<para>
Helper function for printing a sequence of URIs.
</para>
<para>
Intended for use as a <link linkend="raptor-sequence-print-handler"><type>raptor_sequence_print_handler</type></link> passed into
<link linkend="raptor-new-sequence"><function>raptor_new_sequence()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> data item (a <link linkend="raptor-uri"><type>raptor_uri</type></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fh</parameter> :</term>
<listitem><simpara> file handle to print to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-set-print-handler" role="function"/>raptor_sequence_set_print_handler ()</title>
<indexterm><primary>raptor_sequence_set_print_handler</primary></indexterm><programlisting><link linkend="void">void</link> raptor_sequence_set_print_handler
(<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="raptor-sequence-print-handler">raptor_sequence_print_handler</link> *print_handler);</programlisting>
<para>
Set the print handler for the sequence.
</para>
<para>
This is set in the <link linkend="raptor-new-sequence"><function>raptor_new_sequence()</function></link> constructor and can be
overridden here.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>print_handler</parameter> :</term>
<listitem><simpara> print handler
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-print" role="function"/>raptor_sequence_print ()</title>
<indexterm><primary>raptor_sequence_print</primary></indexterm><programlisting><link linkend="void">void</link> raptor_sequence_print (<link linkend="raptor-sequence">raptor_sequence</link> *seq,
<link linkend="FILE:CAPS">FILE</link> *fh);</programlisting>
<para>
Print the sequence contents using the print_handler to print the data items.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>seq</parameter> :</term>
<listitem><simpara> sequence to sort
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fh</parameter> :</term>
<listitem><simpara> file handle
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-sequence-join" role="function"/>raptor_sequence_join ()</title>
<indexterm><primary>raptor_sequence_join</primary></indexterm><programlisting><link linkend="int">int</link> raptor_sequence_join (<link linkend="raptor-sequence">raptor_sequence</link> *dest,
<link linkend="raptor-sequence">raptor_sequence</link> *src);</programlisting>
<para>
Join two sequences moving all items from one sequence to the end of another.
</para>
<para>
After this operation, sequence src will be empty (zero size) but
will have the same item capacity as before.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara> <link linkend="raptor-sequence"><type>raptor_sequence</type></link> destination sequence
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> <link linkend="raptor-sequence"><type>raptor_sequence</type></link> source sequence
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
