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
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
IntegerList
====================================================================
-->
<module name="IntegerList">
<short>
Provides lists for Integer data types implemented using generics.
</short>
<descr>
<p>
<file>integerlist.pas</file> contains a list for Integer values implemented using generics, and provides the same methods and properties for <var>Integer</var> types as provided for <var>String</var> types in <var>TStringList</var>. Specializations are provided for the Byte, Word, Cardinal, Integer, and Int64 types. Each provides an overloaded <var>Sort</var> method to ensure that the type for the specialization is handled in the method.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
</p>
</descr>
<element name="TByteList">
<short>Implements a specialization of TFPGList for the Byte data type.</short>
<descr>
<p>
<var>TByteList</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Byte values. Internally, it provides a TFPGListEnumerator which is specialized for the Byte type used in the implementation.
</p>
<p>
Use the properties and methods defined in the ancestor class to perform common operations for Byte values, including:
</p>
<ul>
<li>Add</li>
<li>IndexOf</li>
<li>Insert</li>
<li>Extract</li>
<li>Remove</li>
<li>Sort</li>
<li>AddList</li>
<li>Assign</li>
<li>First</li>
<li>Last</li>
<li>Items</li>
<li>List</li>
</ul>
<p>
Items is the default property, and allows access to values by ordinal position or by using an enumerator to traverse the Byte values in List.
</p>
</descr>
<seealso>
<link id="TWordList"/>
<link id="TCardinalList"/>
<link id="TIntegerList"/>
<link id="TInt64List"/>
<link id="#rtl.fgl.TFPGList">TFPGList</link>
<link id="#rtl.fgl.TFPGListEnumerator">TFPGListEnumerator</link>
</seealso>
</element>
<element name="TByteList.Sort">
<short>Sorts the Byte values stored in the list.</short>
<descr>
<p>
<var>Sort</var> is an overloaded method in <var>TByteList</var> which calls the inherited method using the CompareByte function defined in the implementation section.
</p>
</descr>
<seealso>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
</seealso>
</element>
<element name="TWordList">
<short>Implements a specialization of TFPGList for the Word data type.</short>
<descr>
<p>
<var>TWordList</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Word values. Internally, it provides a TFPGListEnumerator which is specialized for the Word type used in the implementation.
</p>
<p>
Use the properties and methods defined in the ancestor class to perform common operations for Word values, including:
</p>
<ul>
<li>Add</li>
<li>IndexOf</li>
<li>Insert</li>
<li>Extract</li>
<li>Remove</li>
<li>Sort</li>
<li>AddList</li>
<li>Assign</li>
<li>First</li>
<li>Last</li>
<li>Items</li>
<li>List</li>
</ul>
<p>
Items is the default property, and allows access to values by ordinal position or by using an enumerator to traverse the Word values in List.
</p>
<code>
// using TWordList properties and methods
// var
// AWordList: TWordList;
// AIndex, ACount: Integer;
// AMax, AValue: Word;
AWordList := TWordList.Create;
AMax := High(Word);
AWordList.Add(Random(AMax));
AWordList.Add(Random(AMax));
AWordList.Add(Random(AMax));
AWordList.Add(Random(AMax));
AWordList.Insert(2, 42);
AWordList.Sort;
ACount := AWordList.Count;
AIndex := AWordList.IndexOf(AWordList.Last);
AValue := AWordList.Last;
AWordList.Last := AValue - 1;
AValue := AWordList.Extract(AInt64List.First);
AIndex := AWordList.Remove(42);
AWordList.Clear;
AWordList.Free;
</code>
</descr>
<seealso>
<link id="TByteList"/>
<link id="TCardinalList"/>
<link id="TIntegerList"/>
<link id="TInt64List"/>
<link id="#rtl.fgl.TFPGList">TFPGList</link>
<link id="#rtl.fgl.TFPGListEnumerator">TFPGListEnumerator</link>
</seealso>
</element>
<element name="TWordList.Sort">
<short>Sorts the Word values stored in the list.</short>
<descr>
<p>
<var>Sort</var> is an overloaded method in <var>TWordList</var> which calls the inherited method using the CompareWord function in the implementation section.
</p>
</descr>
<seealso>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
</seealso>
</element>
<element name="TCardinalList">
<short>Implements a specialization of TFPGList for Cardinal data types.</short>
<descr>
<p>
<var>TCardinalList</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Cardinal values. Internally, it provides a TFPGListEnumerator which is specialized for the Cardinal type used in the implementation.
</p>
<p>
Use the properties and methods defined in the ancestor class to perform common operations for Cardinal values, including:
</p>
<ul>
<li>Add</li>
<li>IndexOf</li>
<li>Insert</li>
<li>Extract</li>
<li>Remove</li>
<li>Sort</li>
<li>AddList</li>
<li>Assign</li>
<li>First</li>
<li>Last</li>
<li>Items</li>
<li>List</li>
</ul>
<p>
Items is the default property, and allows access to values by ordinal position or by using an enumerator to traverse the Cardinal values in List.
</p>
<p>
<b>Example:</b>
</p>
<code>
// using TCardinalList properties and methods
// var
// ACardinalList: TCardinalList;
// AIndex, ACount: Integer;
// AMax, AValue: Cardinal;
ACardinalList := TCardinalList.Create;
AMax := High(Cardinal);
ACardinalList.Add(Random(AMax));
ACardinalList.Add(Random(AMax));
ACardinalList.Add(Random(AMax));
ACardinalList.Add(Random(AMax));
ACardinalList.Insert(2, 42);
ACardinalList.Sort;
ACount := ACardinalList.Count;
AIndex := ACardinalList.IndexOf(ACardinalList.Last);
AValue := ACardinalList.Last;
ACardinalList.Last := AValue - 1;
AValue := ACardinalList.Extract(AInt64List.First);
AIndex := ACardinalList.Remove(42);
ACardinalList.Clear;
ACardinalList.Free;
</code>
<p>
Another example using TCardinalList can be found in the <file>components/jcf2/ReadWrite/diffmerge.pas</file> unit.
</p>
</descr>
<seealso>
<link id="TByteList"/>
<link id="TWordList"/>
<link id="TIntegerList"/>
<link id="TInt64List"/>
<link id="TCardinalList.Sort"/>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
<link id="#rtl.fgl.TFPGList">TFPGList</link>
<link id="#rtl.fgl.TFPGListEnumerator">TFPGListEnumerator</link>
</seealso>
</element>
<element name="TCardinalList.Sort">
<short>Sorts the Word values stored in the list.</short>
<descr>
<p>
<var>Sort</var> is an overloaded method in <var>TCardinalList</var> which calls the inherited method using the CompareCardinal function in the implementation section.
</p>
</descr>
<seealso>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
</seealso>
</element>
<element name="TIntegerList">
<short>Implements a specialization of TFPGList for Integer data types.</short>
<descr>
<p>
<var>TIntegerList</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Integer values. Internally, it provides a TFPGListEnumerator which is specialized for the Integer type used in the implementation.
</p>
<p>
Use the properties and methods defined in the ancestor class to perform common operations for Integer values, including:
</p>
<ul>
<li>Add</li>
<li>IndexOf</li>
<li>Insert</li>
<li>Extract</li>
<li>Remove</li>
<li>Sort</li>
<li>AddList</li>
<li>Assign</li>
<li>First</li>
<li>Last</li>
<li>Items</li>
<li>List</li>
</ul>
<p>
Items is the default property, and allows access to values by ordinal position or by using an enumerator to traverse the Integer values in List.
</p>
<p>
<b>Examples:</b>
</p>
<code>
// using TIntegerList properties and methods
// var
// AIntegerList: TIntegerList;
// AIndex, ACount: Integer;
// AMax, AValue: Integer;
AIntegerList := TIntegerList.Create;
AMax := High(Integer);
AIntegerList.Add(Random(AMax));
AIntegerList.Add(Random(AMax));
AIntegerList.Add(Random(AMax));
AIntegerList.Add(Random(AMax));
AIntegerList.Insert(2, 42);
AIntegerList.Sort;
ACount := AIntegerList.Count;
AIndex := AIntegerList.IndexOf(AIntegerList.Last);
AValue := AIntegerList.Last;
AIntegerList.Last := AValue - 1;
AValue := AIntegerList.Extract(AInt64List.First);
AIndex := AIntegerList.Remove(42);
AIntegerList.Clear;
AIntegerList.Free;
</code>
<p>
An example using TIntegerList can be found in the implementation of the TCustomGrid class in <file>lcl/grids.pas</file>.
</p>
</descr>
<seealso>
<link id="TByteList"/>
<link id="TWordList"/>
<link id="TCardinalList"/>
<link id="TInt64List"/>
<link id="TIntegerList.Sort"/>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
<link id="#rtl.fgl.TFPGList">TFPGList</link>
<link id="#rtl.fgl.TFPGListEnumerator">TFPGListEnumerator</link>
</seealso>
</element>
<element name="TIntegerList.Sort">
<short>Sorts the Integer values stored in the list.</short>
<descr>
<p>
<var>Sort</var> is an overloaded method in <var>TIntegerList</var> which calls the inherited method using the CompareInteger function in the implementation section.
</p>
</descr>
<seealso>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
</seealso>
</element>
<element name="TInt64List">
<short>Implements a specialization of TFPGList for Int64 data types.</short>
<descr>
<p>
<var>TInt64List</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Int64 values. Internally, it provides a TFPGListEnumerator which is specialized for the Int64 type used in the implementation.
</p>
<p>
<var>TIntegerList</var> provides an overloaded <var>Sort</var> method to ensure that values in the list are handled using a compare function that operates on Int64 values. Internally, it provides a TFPGListEnumerator which is specialized for the Int64 type used in the implementation.
</p>
<p>
Use the properties and methods defined in the ancestor class to perform common operations for Integer values, including:
</p>
<ul>
<li>Add</li>
<li>IndexOf</li>
<li>Insert</li>
<li>Extract</li>
<li>Remove</li>
<li>Sort</li>
<li>AddList</li>
<li>Assign</li>
<li>First</li>
<li>Last</li>
<li>Items</li>
<li>List</li>
</ul>
<p>
Items is the default property, and allows access to values by ordinal position or by using an enumerator to traverse the Int64 values in List.
</p>
<p>
<b>Example:</b>
</p>
<code>
// using TInt64List properties and methods
// var
// AInt64List: TInt64List;
// AIndex, ACount: Integer;
// AMax, AValue: Int64;
AInt64List := TInt64List.Create;
ACount := 25;
AMax := High(Int64);
for AIndex := 1 to ACount do
AInt64List.Add(Random(AMax));
AInt64List.Insert(4, 42);
AInt64List.Sort;
ACount := AInt64List.Count;
AIndex := AInt64List.IndexOf(AInt64List.Last);
AValue := AInt64List.Last;
AInt64List.Last := AValue - 1;
AValue := AInt64List.Extract(AInt64List.First);
AIndex := AInt64List.Remove(42);
AInt64List.Clear;
AInt64List.Free;
</code>
</descr>
<seealso>
<link id="TByteList"/>
<link id="TWordList"/>
<link id="TCardinalList"/>
<link id="TIntegerList"/>
<link id="TInt64List.Sort"/>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
<link id="#rtl.fgl.TFPGList">TFPGList</link>
<link id="#rtl.fgl.TFPGListEnumerator">TFPGListEnumerator</link>
</seealso>
</element>
<element name="TInt64List.Sort">
<short>Sorts the Int64 values stored in the list.</short>
<descr>
<p>
<var>Sort</var> is an overloaded method in <var>TInt64List</var> which calls the inherited method using the CompareInt64 function in the implementation section.
</p>
</descr>
<seealso>
<link id="#rtl.fgl.TFPGList.Sort">TFPGList.Sort</link>
</seealso>
</element>
</module>
<!-- IntegerList -->
</package>
</fpdoc-descriptions>
|
