1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . F O R M A L _ O R D E R E D _ M A P S --
9 -- Copyright (C) 2010-2013, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
26 ------------------------------------------------------------------------------
28 with Ada
.Containers
.Red_Black_Trees
.Generic_Bounded_Operations
;
30 (Ada
.Containers
.Red_Black_Trees
.Generic_Bounded_Operations
);
32 with Ada
.Containers
.Red_Black_Trees
.Generic_Bounded_Keys
;
33 pragma Elaborate_All
(Ada
.Containers
.Red_Black_Trees
.Generic_Bounded_Keys
);
35 with System
; use type System
.Address
;
37 package body Ada
.Containers
.Formal_Ordered_Maps
is
39 -----------------------------
40 -- Node Access Subprograms --
41 -----------------------------
43 -- These subprograms provide a functional interface to access fields
44 -- of a node, and a procedural interface for modifying these values.
47 (Node
: Node_Type
) return Ada
.Containers
.Red_Black_Trees
.Color_Type
;
48 pragma Inline
(Color
);
50 function Left_Son
(Node
: Node_Type
) return Count_Type
;
53 function Parent
(Node
: Node_Type
) return Count_Type
;
54 pragma Inline
(Parent
);
56 function Right_Son
(Node
: Node_Type
) return Count_Type
;
57 pragma Inline
(Right
);
60 (Node
: in out Node_Type
;
61 Color
: Ada
.Containers
.Red_Black_Trees
.Color_Type
);
62 pragma Inline
(Set_Color
);
64 procedure Set_Left
(Node
: in out Node_Type
; Left
: Count_Type
);
65 pragma Inline
(Set_Left
);
67 procedure Set_Right
(Node
: in out Node_Type
; Right
: Count_Type
);
68 pragma Inline
(Set_Right
);
70 procedure Set_Parent
(Node
: in out Node_Type
; Parent
: Count_Type
);
71 pragma Inline
(Set_Parent
);
73 -----------------------
74 -- Local Subprograms --
75 -----------------------
77 -- All need comments ???
80 with procedure Set_Element
(Node
: in out Node_Type
);
81 procedure Generic_Allocate
82 (Tree
: in out Tree_Types
.Tree_Type
'Class;
83 Node
: out Count_Type
);
85 procedure Free
(Tree
: in out Map
; X
: Count_Type
);
87 function Is_Greater_Key_Node
89 Right
: Node_Type
) return Boolean;
90 pragma Inline
(Is_Greater_Key_Node
);
92 function Is_Less_Key_Node
94 Right
: Node_Type
) return Boolean;
95 pragma Inline
(Is_Less_Key_Node
);
97 --------------------------
98 -- Local Instantiations --
99 --------------------------
101 package Tree_Operations
is
102 new Red_Black_Trees
.Generic_Bounded_Operations
103 (Tree_Types
=> Tree_Types
,
110 new Red_Black_Trees
.Generic_Bounded_Keys
111 (Tree_Operations
=> Tree_Operations
,
112 Key_Type
=> Key_Type
,
113 Is_Less_Key_Node
=> Is_Less_Key_Node
,
114 Is_Greater_Key_Node
=> Is_Greater_Key_Node
);
120 function "=" (Left
, Right
: Map
) return Boolean is
126 if Length
(Left
) /= Length
(Right
) then
130 if Is_Empty
(Left
) then
134 Lst
:= Next
(Left
, Last
(Left
).Node
);
136 Node
:= First
(Left
).Node
;
137 while Node
/= Lst
loop
138 ENode
:= Find
(Right
, Left
.Nodes
(Node
).Key
).Node
;
141 Left
.Nodes
(Node
).Element
/= Right
.Nodes
(ENode
).Element
146 Node
:= Next
(Left
, Node
);
156 procedure Assign
(Target
: in out Map
; Source
: Map
) is
157 procedure Append_Element
(Source_Node
: Count_Type
);
159 procedure Append_Elements
is
160 new Tree_Operations
.Generic_Iteration
(Append_Element
);
166 procedure Append_Element
(Source_Node
: Count_Type
) is
167 SN
: Node_Type
renames Source
.Nodes
(Source_Node
);
169 procedure Set_Element
(Node
: in out Node_Type
);
170 pragma Inline
(Set_Element
);
172 function New_Node
return Count_Type
;
173 pragma Inline
(New_Node
);
175 procedure Insert_Post
is new Key_Ops
.Generic_Insert_Post
(New_Node
);
177 procedure Unconditional_Insert_Sans_Hint
is
178 new Key_Ops
.Generic_Unconditional_Insert
(Insert_Post
);
180 procedure Unconditional_Insert_Avec_Hint
is
181 new Key_Ops
.Generic_Unconditional_Insert_With_Hint
183 Unconditional_Insert_Sans_Hint
);
185 procedure Allocate
is new Generic_Allocate
(Set_Element
);
191 function New_Node
return Count_Type
is
194 Allocate
(Target
, Result
);
202 procedure Set_Element
(Node
: in out Node_Type
) is
205 Node
.Element
:= SN
.Element
;
208 Target_Node
: Count_Type
;
210 -- Start of processing for Append_Element
213 Unconditional_Insert_Avec_Hint
217 Node
=> Target_Node
);
220 -- Start of processing for Assign
223 if Target
'Address = Source
'Address then
227 if Target
.Capacity
< Length
(Source
) then
228 raise Storage_Error
with "not enough capacity"; -- SE or CE? ???
231 Tree_Operations
.Clear_Tree
(Target
);
232 Append_Elements
(Source
);
239 function Ceiling
(Container
: Map
; Key
: Key_Type
) return Cursor
is
240 Node
: constant Count_Type
:= Key_Ops
.Ceiling
(Container
, Key
);
247 return (Node
=> Node
);
254 procedure Clear
(Container
: in out Map
) is
256 Tree_Operations
.Clear_Tree
(Container
);
263 function Color
(Node
: Node_Type
) return Color_Type
is
272 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean is
274 return Find
(Container
, Key
) /= No_Element
;
281 function Copy
(Source
: Map
; Capacity
: Count_Type
:= 0) return Map
is
282 Node
: Count_Type
:= 1;
286 return Target
: Map
(Count_Type
'Max (Source
.Capacity
, Capacity
)) do
287 if Length
(Source
) > 0 then
288 Target
.Length
:= Source
.Length
;
289 Target
.Root
:= Source
.Root
;
290 Target
.First
:= Source
.First
;
291 Target
.Last
:= Source
.Last
;
292 Target
.Free
:= Source
.Free
;
294 while Node
<= Source
.Capacity
loop
295 Target
.Nodes
(Node
).Element
:=
296 Source
.Nodes
(Node
).Element
;
297 Target
.Nodes
(Node
).Key
:=
298 Source
.Nodes
(Node
).Key
;
299 Target
.Nodes
(Node
).Parent
:=
300 Source
.Nodes
(Node
).Parent
;
301 Target
.Nodes
(Node
).Left
:=
302 Source
.Nodes
(Node
).Left
;
303 Target
.Nodes
(Node
).Right
:=
304 Source
.Nodes
(Node
).Right
;
305 Target
.Nodes
(Node
).Color
:=
306 Source
.Nodes
(Node
).Color
;
307 Target
.Nodes
(Node
).Has_Element
:=
308 Source
.Nodes
(Node
).Has_Element
;
312 while Node
<= Target
.Capacity
loop
314 Formal_Ordered_Maps
.Free
(Tree
=> Target
, X
=> N
);
325 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
) is
327 if not Has_Element
(Container
, Position
) then
328 raise Constraint_Error
with
329 "Position cursor of Delete has no element";
332 pragma Assert
(Vet
(Container
, Position
.Node
),
333 "Position cursor of Delete is bad");
335 Tree_Operations
.Delete_Node_Sans_Free
(Container
,
337 Formal_Ordered_Maps
.Free
(Container
, Position
.Node
);
340 procedure Delete
(Container
: in out Map
; Key
: Key_Type
) is
341 X
: constant Node_Access
:= Key_Ops
.Find
(Container
, Key
);
345 raise Constraint_Error
with "key not in map";
348 Tree_Operations
.Delete_Node_Sans_Free
(Container
, X
);
349 Formal_Ordered_Maps
.Free
(Container
, X
);
356 procedure Delete_First
(Container
: in out Map
) is
357 X
: constant Node_Access
:= First
(Container
).Node
;
360 Tree_Operations
.Delete_Node_Sans_Free
(Container
, X
);
361 Formal_Ordered_Maps
.Free
(Container
, X
);
369 procedure Delete_Last
(Container
: in out Map
) is
370 X
: constant Node_Access
:= Last
(Container
).Node
;
373 Tree_Operations
.Delete_Node_Sans_Free
(Container
, X
);
374 Formal_Ordered_Maps
.Free
(Container
, X
);
382 function Element
(Container
: Map
; Position
: Cursor
) return Element_Type
is
384 if not Has_Element
(Container
, Position
) then
385 raise Constraint_Error
with
386 "Position cursor of function Element has no element";
389 pragma Assert
(Vet
(Container
, Position
.Node
),
390 "Position cursor of function Element is bad");
392 return Container
.Nodes
(Position
.Node
).Element
;
396 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
is
397 Node
: constant Node_Access
:= Find
(Container
, Key
).Node
;
401 raise Constraint_Error
with "key not in map";
404 return Container
.Nodes
(Node
).Element
;
407 ---------------------
408 -- Equivalent_Keys --
409 ---------------------
411 function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean is
426 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
) is
427 X
: constant Node_Access
:= Key_Ops
.Find
(Container
, Key
);
430 Tree_Operations
.Delete_Node_Sans_Free
(Container
, X
);
431 Formal_Ordered_Maps
.Free
(Container
, X
);
439 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
is
440 Node
: constant Count_Type
:= Key_Ops
.Find
(Container
, Key
);
447 return (Node
=> Node
);
454 function First
(Container
: Map
) return Cursor
is
456 if Length
(Container
) = 0 then
460 return (Node
=> Container
.First
);
467 function First_Element
(Container
: Map
) return Element_Type
is
469 if Is_Empty
(Container
) then
470 raise Constraint_Error
with "map is empty";
473 return Container
.Nodes
(First
(Container
).Node
).Element
;
480 function First_Key
(Container
: Map
) return Key_Type
is
482 if Is_Empty
(Container
) then
483 raise Constraint_Error
with "map is empty";
486 return Container
.Nodes
(First
(Container
).Node
).Key
;
493 function Floor
(Container
: Map
; Key
: Key_Type
) return Cursor
is
494 Node
: constant Count_Type
:= Key_Ops
.Floor
(Container
, Key
);
501 return (Node
=> Node
);
513 Tree
.Nodes
(X
).Has_Element
:= False;
514 Tree_Operations
.Free
(Tree
, X
);
517 ----------------------
518 -- Generic_Allocate --
519 ----------------------
521 procedure Generic_Allocate
522 (Tree
: in out Tree_Types
.Tree_Type
'Class;
523 Node
: out Count_Type
)
525 procedure Allocate
is
526 new Tree_Operations
.Generic_Allocate
(Set_Element
);
528 Allocate
(Tree
, Node
);
529 Tree
.Nodes
(Node
).Has_Element
:= True;
530 end Generic_Allocate
;
536 function Has_Element
(Container
: Map
; Position
: Cursor
) return Boolean is
538 if Position
.Node
= 0 then
542 return Container
.Nodes
(Position
.Node
).Has_Element
;
550 (Container
: in out Map
;
552 New_Item
: Element_Type
)
558 Insert
(Container
, Key
, New_Item
, Position
, Inserted
);
562 N
: Node_Type
renames Container
.Nodes
(Position
.Node
);
565 N
.Element
:= New_Item
;
571 (Container
: in out Map
;
573 New_Item
: Element_Type
;
574 Position
: out Cursor
;
575 Inserted
: out Boolean)
577 function New_Node
return Node_Access
;
580 procedure Insert_Post
is
581 new Key_Ops
.Generic_Insert_Post
(New_Node
);
583 procedure Insert_Sans_Hint
is
584 new Key_Ops
.Generic_Conditional_Insert
(Insert_Post
);
590 function New_Node
return Node_Access
is
591 procedure Initialize
(Node
: in out Node_Type
);
592 procedure Allocate_Node
is new Generic_Allocate
(Initialize
);
594 procedure Initialize
(Node
: in out Node_Type
) is
597 Node
.Element
:= New_Item
;
603 Allocate_Node
(Container
, X
);
607 -- Start of processing for Insert
618 (Container
: in out Map
;
620 New_Item
: Element_Type
)
626 Insert
(Container
, Key
, New_Item
, Position
, Inserted
);
629 raise Constraint_Error
with "key already in map";
637 function Is_Empty
(Container
: Map
) return Boolean is
639 return Length
(Container
) = 0;
642 -------------------------
643 -- Is_Greater_Key_Node --
644 -------------------------
646 function Is_Greater_Key_Node
648 Right
: Node_Type
) return Boolean
651 -- k > node same as node < k
653 return Right
.Key
< Left
;
654 end Is_Greater_Key_Node
;
656 ----------------------
657 -- Is_Less_Key_Node --
658 ----------------------
660 function Is_Less_Key_Node
662 Right
: Node_Type
) return Boolean
665 return Left
< Right
.Key
;
666 end Is_Less_Key_Node
;
672 function Key
(Container
: Map
; Position
: Cursor
) return Key_Type
is
674 if not Has_Element
(Container
, Position
) then
675 raise Constraint_Error
with
676 "Position cursor of function Key has no element";
679 pragma Assert
(Vet
(Container
, Position
.Node
),
680 "Position cursor of function Key is bad");
682 return Container
.Nodes
(Position
.Node
).Key
;
689 function Last
(Container
: Map
) return Cursor
is
691 if Length
(Container
) = 0 then
695 return (Node
=> Container
.Last
);
702 function Last_Element
(Container
: Map
) return Element_Type
is
704 if Is_Empty
(Container
) then
705 raise Constraint_Error
with "map is empty";
708 return Container
.Nodes
(Last
(Container
).Node
).Element
;
715 function Last_Key
(Container
: Map
) return Key_Type
is
717 if Is_Empty
(Container
) then
718 raise Constraint_Error
with "map is empty";
721 return Container
.Nodes
(Last
(Container
).Node
).Key
;
728 function Left
(Container
: Map
; Position
: Cursor
) return Map
is
729 Curs
: Cursor
:= Position
;
730 C
: Map
(Container
.Capacity
) := Copy
(Container
, Container
.Capacity
);
734 if Curs
= No_Element
then
738 if not Has_Element
(Container
, Curs
) then
739 raise Constraint_Error
;
742 while Curs
.Node
/= 0 loop
745 Curs
:= Next
(Container
, (Node
=> Node
));
755 function Left_Son
(Node
: Node_Type
) return Count_Type
is
764 function Length
(Container
: Map
) return Count_Type
is
766 return Container
.Length
;
773 procedure Move
(Target
: in out Map
; Source
: in out Map
) is
774 NN
: Tree_Types
.Nodes_Type
renames Source
.Nodes
;
778 if Target
'Address = Source
'Address then
782 if Target
.Capacity
< Length
(Source
) then
783 raise Constraint_Error
with -- ???
784 "Source length exceeds Target capacity";
790 X
:= First
(Source
).Node
;
793 -- Here we insert a copy of the source element into the target, and
794 -- then delete the element from the source. Another possibility is
795 -- that delete it first (and hang onto its index), then insert it.
798 Insert
(Target
, NN
(X
).Key
, NN
(X
).Element
); -- optimize???
800 Tree_Operations
.Delete_Node_Sans_Free
(Source
, X
);
801 Formal_Ordered_Maps
.Free
(Source
, X
);
809 procedure Next
(Container
: Map
; Position
: in out Cursor
) is
811 Position
:= Next
(Container
, Position
);
814 function Next
(Container
: Map
; Position
: Cursor
) return Cursor
is
816 if Position
= No_Element
then
820 if not Has_Element
(Container
, Position
) then
821 raise Constraint_Error
;
824 pragma Assert
(Vet
(Container
, Position
.Node
),
825 "bad cursor in Next");
827 return (Node
=> Tree_Operations
.Next
(Container
, Position
.Node
));
834 function Overlap
(Left
, Right
: Map
) return Boolean is
836 if Length
(Left
) = 0 or Length
(Right
) = 0 then
841 L_Node
: Count_Type
:= First
(Left
).Node
;
842 R_Node
: Count_Type
:= First
(Right
).Node
;
843 L_Last
: constant Count_Type
:= Next
(Left
, Last
(Left
).Node
);
844 R_Last
: constant Count_Type
:= Next
(Right
, Last
(Right
).Node
);
847 if Left
'Address = Right
'Address then
853 or else R_Node
= R_Last
858 if Left
.Nodes
(L_Node
).Key
< Right
.Nodes
(R_Node
).Key
then
859 L_Node
:= Next
(Left
, L_Node
);
861 elsif Right
.Nodes
(R_Node
).Key
< Left
.Nodes
(L_Node
).Key
then
862 R_Node
:= Next
(Right
, R_Node
);
875 function Parent
(Node
: Node_Type
) return Count_Type
is
884 procedure Previous
(Container
: Map
; Position
: in out Cursor
) is
886 Position
:= Previous
(Container
, Position
);
889 function Previous
(Container
: Map
; Position
: Cursor
) return Cursor
is
891 if Position
= No_Element
then
895 if not Has_Element
(Container
, Position
) then
896 raise Constraint_Error
;
899 pragma Assert
(Vet
(Container
, Position
.Node
),
900 "bad cursor in Previous");
903 Node
: constant Count_Type
:=
904 Tree_Operations
.Previous
(Container
, Position
.Node
);
911 return (Node
=> Node
);
920 (Container
: in out Map
;
922 New_Item
: Element_Type
)
926 Node
: constant Node_Access
:= Key_Ops
.Find
(Container
, Key
);
930 raise Constraint_Error
with "key not in map";
934 N
: Node_Type
renames Container
.Nodes
(Node
);
937 N
.Element
:= New_Item
;
942 ---------------------
943 -- Replace_Element --
944 ---------------------
946 procedure Replace_Element
947 (Container
: in out Map
;
949 New_Item
: Element_Type
)
952 if not Has_Element
(Container
, Position
) then
953 raise Constraint_Error
with
954 "Position cursor of Replace_Element has no element";
957 pragma Assert
(Vet
(Container
, Position
.Node
),
958 "Position cursor of Replace_Element is bad");
960 Container
.Nodes
(Position
.Node
).Element
:= New_Item
;
967 function Right
(Container
: Map
; Position
: Cursor
) return Map
is
968 Curs
: Cursor
:= First
(Container
);
969 C
: Map
(Container
.Capacity
) := Copy
(Container
, Container
.Capacity
);
973 if Curs
= No_Element
then
978 if Position
/= No_Element
and not Has_Element
(Container
, Position
) then
979 raise Constraint_Error
;
982 while Curs
.Node
/= Position
.Node
loop
985 Curs
:= Next
(Container
, (Node
=> Node
));
995 function Right_Son
(Node
: Node_Type
) return Count_Type
is
1004 procedure Set_Color
(Node
: in out Node_Type
; Color
: Color_Type
) is
1006 Node
.Color
:= Color
;
1013 procedure Set_Left
(Node
: in out Node_Type
; Left
: Count_Type
) is
1022 procedure Set_Parent
(Node
: in out Node_Type
; Parent
: Count_Type
) is
1024 Node
.Parent
:= Parent
;
1031 procedure Set_Right
(Node
: in out Node_Type
; Right
: Count_Type
) is
1033 Node
.Right
:= Right
;
1040 function Strict_Equal
(Left
, Right
: Map
) return Boolean is
1041 LNode
: Count_Type
:= First
(Left
).Node
;
1042 RNode
: Count_Type
:= First
(Right
).Node
;
1045 if Length
(Left
) /= Length
(Right
) then
1049 while LNode
= RNode
loop
1054 if Left
.Nodes
(LNode
).Element
/= Right
.Nodes
(RNode
).Element
1055 or else Left
.Nodes
(LNode
).Key
/= Right
.Nodes
(RNode
).Key
1060 LNode
:= Next
(Left
, LNode
);
1061 RNode
:= Next
(Right
, RNode
);
1067 end Ada
.Containers
.Formal_Ordered_Maps
;