File: avglvltree.xml

package info (click to toggle)
lazarus 2.0.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 214,460 kB
  • sloc: pascal: 1,862,622; xml: 265,709; cpp: 56,595; sh: 3,008; java: 609; makefile: 535; perl: 297; sql: 222; ansic: 137
file content (1009 lines) | stat: -rw-r--r-- 37,222 bytes parent folder | download | duplicates (2)
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lazutils">
    <!--
  ====================================================================
    AvgLvlTree
  ====================================================================
-->
    <module name="AvgLvlTree">
      <short>An Average Level Tree structure, which is kept balanced so that finding a node is very rapid</short>
      <descr/>
      <!-- unresolved type reference Visibility: default -->
      <element name="Classes">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="SysUtils">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- unresolved type reference Visibility: default -->
      <element name="FPCAdds">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- function type Visibility: default -->
      <element name="TObjectSortCompare">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TObjectSortCompare.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TObjectSortCompare.Tree">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TObjectSortCompare.Data1">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TObjectSortCompare.Data2">
        <short/>
      </element>
      <!-- object Visibility: default -->
      <element name="TAvgLvlTreeNode">
        <short>
          <var>TAvgLvlTreeNode</var> - a node, the basic structural element of a <var>TAvgLvlTree</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTreeNode.Parent">
        <short>
          <var>Parent</var> - the previous level in the tree</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTreeNode.Left">
        <short>The <var>Left</var> descendant branch node in the tree</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTreeNode.Right">
        <short>The <var>Right</var> descendant branch node in the tree</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTreeNode.Balance">
        <short>
          <var>Balance</var> - should be 0 for perfect balance, -1 or +1 for one extra node on either side, more than (+ or -) 1 means tree is unbalanced and needs to be fixed</short>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTreeNode.Data">
        <short>A pointer to the actual <var>Data</var> associated with the node</short>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTreeNode.Clear">
        <short>
          <var>Clear</var> - remove all the branches leaving an empty tree</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTreeNode.TreeDepth">
        <short>
          <var>TreeDepth</var> - the number of levels in the tree structure, by the longest way down</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTreeNode.TreeDepth.Result">
        <short/>
      </element>
      <!-- pointer type Visibility: default -->
      <element name="PAvgLvlTreeNode">
        <short>
          <var>PAvgLvlTreeNode</var> - pointer to a <var>TAvgLvlTreeNode</var>
        </short>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TAvgLvlTree">
        <short>
          <var>TAvgLvlTree</var> - an Average Level binary Tree</short>
        <descr>
          <var>TAvgLvlTree</var> is an Average Level binary Tree. This binary tree is always balanced, so that inserting, deleting and finding a node is performed in O(log(#Nodes))</descr>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTree.FCount">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTree.FOnCompare">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTree.FOnObjectCompare">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTree.BalanceAfterInsert">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.BalanceAfterInsert.ANode">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTree.BalanceAfterDelete">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.BalanceAfterDelete.ANode">
        <short/>
      </element>
      <!-- function Visibility: private -->
      <element name="TAvgLvlTree.FindInsertPos">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindInsertPos.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindInsertPos.Data">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTree.SetOnCompare">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.SetOnCompare.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTree.SetOnObjectCompare">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.SetOnObjectCompare.AValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTree.SetCompares">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.SetCompares.NewCompare">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.SetCompares.NewObjectCompare">
        <short/>
      </element>
      <!-- variable Visibility: public -->
      <element name="TAvgLvlTree.Root">
        <short>
          <var>Root</var> - the starting node of the tree structure</short>
        <descr/>
        <seealso/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.Compare">
        <short>Compare two data. For every two nodes of the tree holds: Compare(Left,Right)</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.Compare.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Compare.Data1">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Compare.Data2">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.Find">
        <short>Find node with a Data of the same key. The found Node.Data need not be the same as the Data parameter.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.Find.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Find.Data">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindKey">
        <short>Search a node with the same key. OnCompareKeyWithData first parameter is the key, second the Node.Data.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindKey.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindKey.Key">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindKey.OnCompareKeyWithData">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindSuccessor">
        <short>Find the next node to the right with the next higher value.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindSuccessor.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindSuccessor.ANode">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindPrecessor">
        <short>Find the next node to the left with the next lower value.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindPrecessor.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindPrecessor.ANode">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindLowest">
        <short>Find the left most node.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindLowest.Result">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindHighest">
        <short>Find the right most node.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindHighest.Result">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindNearest">
        <short>Find a node with the same key. If no node with exact the same key exists a node left or right is returned.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindNearest.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindNearest.Data">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindPointer">
        <short>As Find, but Key and Data must be the same.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindPointer.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindPointer.Data">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindLeftMost">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMost.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMost.Data">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindRightMost">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindRightMost.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindRightMost.Data">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindLeftMostKey">
        <short>As FindKey, but if there are several nodes with the same key, the left most is returned</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMostKey.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMostKey.Key">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMostKey.OnCompareKeyWithData">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindRightMostKey">
        <short>As FindKey, but if there are several nodes with the same key, the right most is returned</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindRightMostKey.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindRightMostKey.Key">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindRightMostKey.OnCompareKeyWithData">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindLeftMostSameKey">
        <short>Starts at ANode and returns the left most node with the same key as ANode.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMostSameKey.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindLeftMostSameKey.ANode">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.FindRightMostSameKey">
        <short>Starts at ANode and returns the left most node with the same key as ANode.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.FindRightMostSameKey.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FindRightMostSameKey.ANode">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.Add">
        <short>Adds a node to the tree</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Add.ANode">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.Add">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.Add.Result">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Add.Data">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.Delete">
        <short>Removes and frees a node. The data is not freed (See FreeAndDelete).</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Delete.ANode">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.Remove">
        <short>if the Data with the same key exists one node is removed.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Remove.Data">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.RemovePointer">
        <short>RemovePointer - if the Data with the same pointer exists one pointer is removed.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.RemovePointer.Data">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.MoveDataLeftMost">
        <short>If there are several nodes with the same Key as ANode, the node is moved left most of this group.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.MoveDataLeftMost.ANode">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.MoveDataRightMost">
        <short>If there are several nodes with the same Key as ANode, the node is moved right most of this group.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.MoveDataRightMost.ANode">
        <short/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTree.OnCompare">
        <short>
          <var>OnCompare</var> - user-supplied event handler to define your own sorting. The tree will be rebuilt without losing data.</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTree.OnObjectCompare">
        <short>Same as OnCompare, but with a method instead of a procedure.</short>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.Clear">
        <short>Delete all nodes without freeing the data. Calls <var>Clear</var> then performs inherited <var>Destroy</var>
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.FreeAndClear">
        <short>Delete all nodes and call TObject(Node.Data).Free on every data.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.FreeAndDelete">
        <short>Call TObject(ANode.Data).Free then delete the node.</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.FreeAndDelete.ANode">
        <short/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTree.Count">
        <short>
          <var>Count</var> - number of nodes</short>
        <descr/>
        <seealso/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.ConsistencyCheck">
        <short>
          <var>ConsistencyCheck</var> - checks that the root node exists and that the tree is correctly balanced with valid nodes on each level</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.ConsistencyCheck.Result">
        <short/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTree.WriteReportToStream">
        <short>
          <var>WriteReportToStream</var> - sends a status report to the current data stream</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.WriteReportToStream.s">
        <short/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.WriteReportToStream.StreamSize">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTree.ReportAsString">
        <short>
          <var>ReportAsString</var> returns the status report sent to the stream, as a string</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTree.ReportAsString.Result">
        <short/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TAvgLvlTree.Create">
        <short>
          <var>Create</var> - constructor for <var>TAvgLvlTree</var>, allowing the comparison method to be passed as an argument. Performs Inherited Create and copies the specified comparison method to a local variable
        </short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.Create.OnCompareMethod">
        <short/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TAvgLvlTree.CreateObjectCompare">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTree.CreateObjectCompare.OnCompareMethod">
        <short/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TAvgLvlTree.Create">
        <short>Version of the <var>Create</var> constructor without specified arguments</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- destructor Visibility: public -->
      <element name="TAvgLvlTree.Destroy">
        <short>
          <var>Destroy</var> - destructor for <var>TAvgLvlTree</var>: </short>
        <descr/>
        <errors/>
        <seealso>
          <link id="#rtl.System.TObject.Destroy"/>
        </seealso>
      </element>
      <!-- pointer type Visibility: default -->
      <element name="PAvgLvlTree">
        <short>
          <var>PAvgLvlTree</var> - a pointer to a <var>TAvgLvlTree</var>
        </short>
        <descr/>
        <seealso/>
      </element>
      <!-- object Visibility: default -->
      <element name="TAvgLvlTreeNodeMemManager">
        <short>
          <var>TAvgLvlTreeNodeMemManager</var> - memory manager for TAvgLvlTree nodes</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.FFirstFree">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.FFreeCount">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.FCount">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.FMinFree">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- variable Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.FMaxFreeRatio">
        <short/>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.SetMaxFreeRatio">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTreeNodeMemManager.SetMaxFreeRatio.NewValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.SetMinFree">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTreeNodeMemManager.SetMinFree.NewValue">
        <short/>
      </element>
      <!-- procedure Visibility: private -->
      <element name="TAvgLvlTreeNodeMemManager.DisposeFirstFreeNode">
        <short/>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.DisposeNode">
        <short>
          <var>DisposeNode</var> - method for disposal of a node when it is no longer needed</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- argument Visibility: default -->
      <element name="TAvgLvlTreeNodeMemManager.DisposeNode.ANode">
        <short/>
      </element>
      <!-- function Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.NewNode">
        <short>
          <var>NewNode</var> - returns a new node fo the structure</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- function result Visibility: default -->
      <element name="TAvgLvlTreeNodeMemManager.NewNode.Result">
        <short/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.MinimumFreeNode">
        <short>
          <var>MinimumFreeNode</var> the value of the smallest (or next) free node</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.MaximumFreeNodeRatio">
        <short>
          <var>MaximumFreeNodeRatio</var> - the maximum allowable ratio of free nodes</short>
        <descr/>
        <seealso/>
      </element>
      <!-- property Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.Count">
        <short>
          <var>Count</var> - the running total of nodes</short>
        <descr/>
        <seealso/>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.Clear">
        <short>
          <var>Clear</var> - remove all the nodes and leave an empty structure</short>
        <descr/>
        <errors/>
        <seealso/>
      </element>
      <!-- constructor Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.Create">
        <short>
          <var>Create</var> - constructor for <var>TAvgLvlTreeNodeMemManager</var>: calls inherited <var>Create</var> then initialises the counters</short>
        <descr/>
        <errors/>
        <seealso>
          <link id="#rtl.System.TObject.Create">TObject.Create</link>
        </seealso>
      </element>
      <!-- destructor Visibility: public -->
      <element name="TAvgLvlTreeNodeMemManager.Destroy">
        <short>
          <var>Destroy</var> - destructor for memory manager: calls <var>Clear</var> then performs inherited <var>Destroy</var>
        </short>
        <descr/>
        <errors/>
        <seealso>
          <link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
        </seealso>
      </element>
      <element name="TAvgLvlTree.FindNearestKey">
        <short>Same as FindKey, but if the exact Key can not be found a Node left or right of it is returned.</short>
      </element>
      <element name="TPointerToPointerItem">
        <short>
          <var>TPointerToPointerItem</var> - an item in a PointerToPointer Tree (associative array)</short>
      </element>
      <element name="TPointerToPointerItem.Key">
        <short>The <var>Key</var> defining the pointer item</short>
      </element>
      <element name="TPointerToPointerItem.Value">
        <short>The <var>Value</var> of the pointer item</short>
      </element>
      <element name="PPointerToPointerItem">
        <short>
          <var>PPointerToPointerItem</var> - a pointer to a <var>TPointerToPointerItem</var>
        </short>
      </element>
      <element name="TPointerToPointerTree">
        <short>
          <var>TPointerToPointerTree</var> - an associative array of PointerToPointer Items, or a tree of trees</short>
        <descr>
          <var>TPointerToPointerTree</var> - an associative array of PointerToPointer Items, or a tree of trees. This class uses pointers to identify pointers within the array, unlike the <var>TStringToStringTree</var>, which uses strings to identify strings.</descr>
      </element>
      <element name="TPointerToPointerTree.Create">
        <short>
          <var>Create</var> - constructor for <var>TPointerToPointerTree</var>. Calls the <var>TAvgLvlTree.Create</var> method</short>
        <seealso>
          <link id="#lcl.AvgLvlTree.TAvgLvlTree.Create">TAvgLvlTree.Create</link>
        </seealso>
      </element>
      <element name="TPointerToPointerTree.Destroy">
        <seealso>
          <link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
        </seealso>
        <short>
          <var>Destroy</var> - destructor for <var>TPointerToPointerTree</var>: <var>Clear</var> the tree, <var>Free</var> the items then call inherited <var>Destroy</var>
        </short>
      </element>
      <element name="TPointerToPointerTree.Clear">
        <short>
          <var>Clear</var> - removes each node from the tree, leaving an empty tree</short>
      </element>
      <element name="TPointerToPointerTree.Remove">
        <short>
          <var>Remove</var> the node specified by <var>Key</var> from the tree</short>
      </element>
      <element name="TPointerToPointerTree.Contains">
        <short>Returns True if the tree <var>Contains</var> the node specified by <var>Key</var>
        </short>
      </element>
      <element name="TPointerToPointerTree.GetFirst">
        <short>
          <var>GetFirst</var> - finds the first node matching the supplied arguments; returns True if successful</short>
      </element>
      <element name="TPointerToPointerTree.GetLast">
        <short>
          <var>GetLast</var> - finds the last node matching the supplied arguments; returns True if successful</short>
      </element>
      <element name="TPointerToPointerTree.GetNext">
        <short>
          <var>GetNext</var> - finds the next node matching the supplied arguments; returns True if successful</short>
      </element>
      <element name="TPointerToPointerTree.GetPrev">
        <short>
          <var>GetPrev</var> - finds the previous node matching the supplied arguments; returns True if successful</short>
      </element>
      <element name="TPointerToPointerTree.Count">
        <short>
          <var>Count</var> - the number of items</short>
      </element>
      <element name="TPointerToPointerTree.Values">
        <short>
          <var>Values</var> - a pointer into the array of values associated with the nodes</short>
      </element>
      <element name="TPointerToPointerTree.Tree">
        <short>The <var>Tree</var> that forms the basis of the associative array</short>
      </element>
      <element name="TStringToStringTree">
        <descr>
          <var>TStringToStringTree</var> - an associative array of StringToString Items, or a tree of trees. This class uses strings to identify strings within the array, unlike the <var>TPointerToPointerTree</var>, which uses pointers to identify pointers.</descr>
        <short>
          <var>TStringToStringTree</var> - an associative array of StringToString Items, or a tree of trees</short>
      </element>
      <element name="TStringToStringItem">
        <short>
          <var>TStringToStringItem</var> - an item in a StringToString Tree (associative array)</short>
      </element>
      <element name="TStringToStringItem.Name">
        <short>The <var>Name</var> that identifies the string within the associative array</short>
      </element>
      <element name="TStringToStringItem.Value">
        <short>The <var>Value</var> of the string held within the associative array</short>
      </element>
      <element name="PStringToStringItem">
        <short>
          <var>PStringToStringItem</var> -  pointer to a TStringToStringItem</short>
      </element>
      <element name="TStringToStringTree.Create">
        <short>The instance of the <var>Create</var> constructor that allows the programmer to specify whether or not the string operations are to be Case Sensitive</short>
        <seealso>
          <link id="#rtl.System.TObject.Create">TObject.Create</link>
        </seealso>
      </element>
      <element name="TStringToStringTree.Create.CaseSensitive">
        <short>
          <var>CaseSensitive</var> - if True, string operations (comparisons etc) must be case sensitive</short>
      </element>
      <element name="TStringToStringTree.Create">
        <short>The instance of the <var>Create</var> constructor that allows the programmer to specify how items in the list are to be compared</short>
        <seealso>
          <link id="#rtl.System.TObject.Create">TObject.Create</link>
        </seealso>
      </element>
      <element name="TStringToStringTree.Destroy">
        <short>
          <var>Destroy</var> - destructor for <var>TStringToStringTree</var>: calls <var>Clear</var>, frees items then calls inherited <var>Destroy</var>
        </short>
      </element>
      <element name="TStringToStringTree.Clear">
        <short>
          <var>Clear</var> - removes all items leaving an empty tree</short>
      </element>
      <element name="TStringToStringTree.Contains">
        <short>Returns True if the tree <var>Contains</var> the specified string</short>
      </element>
      <element name="TStringToStringTree.Add">
        <short>
          <var>Add</var> an item to the tree (specified by its name, value or delimiter)</short>
      </element>
      <element name="TStringToStringTree.AddNameValues">
        <short>
          <var>AddNameValues</var> add the specified named values to the tree</short>
      </element>
      <element name="TStringToStringTree.AddValues">
        <short>
          <var>AddValues</var> - adds the specified values to the tree</short>
      </element>
      <element name="TStringToStringTree.GetFirst">
        <short>
          <var>GetFirst</var> - finds the matching first item; returns True if successful</short>
      </element>
      <element name="TStringToStringTree.GetLast">
        <short>
          <var>GetLast</var> - finds the last matching item; returns True if successful</short>
      </element>
      <element name="TStringToStringTree.GetNext">
        <short>
          <var>GetNext</var> - finds the next matching item; returns True if successful</short>
      </element>
      <element name="TStringToStringTree.GetPrev">
        <short>
          <var>GetPrev</var> - finds the previous matching item; returns True if successful</short>
      </element>
      <element name="TStringToStringTree.Count">
        <short>
          <var>Count</var> - the number of items</short>
      </element>
      <element name="TStringToStringTree.Values">
        <short>The <var>Values</var> of the strings corresponding to the supplied name</short>
      </element>
      <element name="TStringToStringTree.Tree">
        <short>The <var>Tree</var> that forms the basis of the associative array</short>
      </element>
      <element name="TStringToStringTree.CompareItems">
        <short>
          <var>CompareItems</var> - the items for comparison</short>
      </element>
      <element name="TStringToStringTree.CompareNameWithItem">
        <short>
          <var>CompareNameWithItem</var> - the name for comparison with the item</short>
      </element>
    <element name="TAvgLvlTree.GetEnumerator"><short>The default enumerator over the nodes from left to right, low to high</short>
      </element>
    <element name="TAvgLvlTree.AddAscendingSequence"><short>Fast Add for adding a sequence of items.</short><descr> This is an optimized version of "Add" for adding an ascending sequence of nodes.
  It uses the LastAdded and Successor to skip searching for an insert position.
  For nodes with same value the order of the sequence is kept.

  Usage:
    LastNode:=nil; // TAvgLvlTreeNode
    Successor:=nil; // TAvgLvlTreeNode
    for i:=1 to 1000 do
      LastNode:=Tree.AddAscendingSequence(TItem.Create(i),LastNode,Successor);
</descr>
      </element>
    <element name="TAvgLvlTree.OwnsObjects"><short>Enable to treat Node.Data as TObject and free on delete</short>
      </element>
    </module>
    <!-- AvgLvlTree -->
  </package>
</fpdoc-descriptions>