A.18.3 The Package Containers.Doubly_Linked_Lists
The language-defined generic package Containers.Doubly_Linked_Lists
provides private types List and Cursor, and a set of operations for each
type. A list container is optimized for insertion and deletion at any
position.
A doubly-linked list container
object manages a linked list of internal
nodes, each of which
contains an element and pointers to the next (successor) and previous
(predecessor) internal nodes. A cursor designates a particular node within
a list (and by extension the element contained in that node). A cursor
keeps designating the same node (and element) as long as the node is
part of the container, even if the node is moved in the container.
The
length of a list is the number of elements
it contains.
Static Semantics
The generic library
package Containers.Doubly_Linked_Lists has the following declaration:
generic
type Element_Type
is private;
with function "=" (Left, Right : Element_Type)
return Boolean
is <>;
package Ada.Containers.Doubly_Linked_Lists
is
pragma Preelaborate(Doubly_Linked_Lists);
type List
is tagged private;
pragma Preelaborable_Initialization(List);
type Cursor
is private;
pragma Preelaborable_Initialization(Cursor);
Empty_List :
constant List;
No_Element :
constant Cursor;
function "=" (Left, Right : List) return Boolean;
function Length (Container : List)
return Count_Type;
function Is_Empty (Container : List)
return Boolean;
procedure Clear (Container :
in out List);
function Element (Position : Cursor)
return Element_Type;
procedure Replace_Element (Container :
in out List;
Position :
in Cursor;
New_Item :
in Element_Type);
procedure Query_Element
(Position :
in Cursor;
Process :
not null access procedure (Element :
in Element_Type));
procedure Update_Element
(Container :
in out List;
Position :
in Cursor;
Process :
not null access procedure
(Element :
in out Element_Type));
procedure Move (Target :
in out List;
Source :
in out List);
procedure Insert (Container :
in out List;
Before :
in Cursor;
New_Item :
in Element_Type;
Count :
in Count_Type := 1);
procedure Insert (Container :
in out List;
Before :
in Cursor;
New_Item :
in Element_Type;
Position :
out Cursor;
Count :
in Count_Type := 1);
procedure Insert (Container :
in out List;
Before :
in Cursor;
Position :
out Cursor;
Count :
in Count_Type := 1);
procedure Prepend (Container :
in out List;
New_Item :
in Element_Type;
Count :
in Count_Type := 1);
procedure Append (Container :
in out List;
New_Item :
in Element_Type;
Count :
in Count_Type := 1);
procedure Delete (Container :
in out List;
Position :
in out Cursor;
Count :
in Count_Type := 1);
procedure Delete_First (Container :
in out List;
Count :
in Count_Type := 1);
procedure Delete_Last (Container :
in out List;
Count :
in Count_Type := 1);
procedure Reverse_Elements (Container :
in out List);
procedure Swap (Container :
in out List;
I, J :
in Cursor);
procedure Swap_Links (Container :
in out List;
I, J :
in Cursor);
procedure Splice (Target :
in out List;
Before :
in Cursor;
Source :
in out List);
procedure Splice (Target :
in out List;
Before :
in Cursor;
Source :
in out List;
Position :
in out Cursor);
procedure Splice (Container:
in out List;
Before :
in Cursor;
Position :
in Cursor);
function First (Container : List)
return Cursor;
function First_Element (Container : List)
return Element_Type;
function Last (Container : List)
return Cursor;
function Last_Element (Container : List)
return Element_Type;
function Next (Position : Cursor)
return Cursor;
function Previous (Position : Cursor)
return Cursor;
procedure Next (Position :
in out Cursor);
procedure Previous (Position :
in out Cursor);
function Find (Container : List;
Item : Element_Type;
Position : Cursor := No_Element)
return Cursor;
function Reverse_Find (Container : List;
Item : Element_Type;
Position : Cursor := No_Element)
return Cursor;
function Contains (Container : List;
Item : Element_Type)
return Boolean;
function Has_Element (Position : Cursor)
return Boolean;
procedure Iterate
(Container :
in List;
Process :
not null access procedure (Position :
in Cursor));
procedure Reverse_Iterate
(Container :
in List;
Process :
not null access procedure (Position :
in Cursor));
generic
with function "<" (Left, Right : Element_Type)
return Boolean is <>;
package Generic_Sorting
is
function Is_Sorted (Container : List)
return Boolean;
procedure Sort (Container :
in out List);
procedure Merge (Target :
in out List;
Source :
in out List);
end Generic_Sorting;
private
... -- not specified by the language
end Ada.Containers.Doubly_Linked_Lists;
The actual function for the generic formal function
"=" on Element_Type values is expected to define a reflexive
and symmetric relationship and return the same result value each time
it is called with a particular pair of values. If it behaves in some
other manner, the functions Find, Reverse_Find, and "=" on
list values return an unspecified value. The exact arguments and number
of calls of this generic formal function by the functions Find, Reverse_Find,
and "=" on list values are unspecified.
The type List is used to represent lists. The type
List needs finalization (see
7.6).
Empty_List represents the empty List object. It has
a length of 0. If an object of type List is not otherwise initialized,
it is initialized to the same value as Empty_List.
No_Element represents a cursor that designates no
element. If an object of type Cursor is not otherwise initialized, it
is initialized to the same value as No_Element.
The predefined "=" operator for type Cursor
returns True if both cursors are No_Element, or designate the same element
in the same container.
Execution of the default implementation of the Input,
Output, Read, or Write attribute of type Cursor raises Program_Error.
Some operations of this generic package have access-to-subprogram
parameters. To ensure such operations are well-defined, they guard against
certain actions by the designated subprogram. In particular, some operations
check for “tampering with cursors” of a container because
they depend on the set of elements of the container remaining constant,
and others check for “tampering with elements” of a container
because they depend on elements of the container not being replaced.
A
subprogram is said to
tamper with cursors of a list object
L
if:
it inserts or deletes elements of L, that
is, it calls the Insert, Clear, Delete, or Delete_Last procedures with
L as a parameter; or
it reorders the elements of L, that is,
it calls the Splice, Swap_Links, or Reverse_Elements procedures or the
Sort or Merge procedures of an instance of Generic_Sorting with L
as a parameter; or
it finalizes L; or
it calls the Move procedure with L as a
parameter.
A
subprogram is said to
tamper with elements of a list object
L
if:
it tampers with cursors of L; or
it replaces one or more elements of L, that
is, it calls the Replace_Element or Swap procedures with L as
a parameter.
function "=" (Left, Right : List) return Boolean;
If Left and Right
denote the same list object, then the function returns True. If Left
and Right have different lengths, then the function returns False. Otherwise,
it compares each element in Left to the corresponding element in Right
using the generic formal equality operator. If any such comparison returns
False, the function returns False; otherwise it returns True. Any exception
raised during evaluation of element equality is propagated.
function Length (Container : List) return Count_Type;
Returns the number
of elements in Container.
function Is_Empty (Container : List) return Boolean;
Equivalent to Length
(Container) = 0.
procedure Clear (Container : in out List);
Removes all the
elements from Container.
function Element (Position : Cursor) return Element_Type;
If Position equals
No_Element, then Constraint_Error is propagated. Otherwise, Element returns
the element designated by Position.
procedure Replace_Element (Container : in out List;
Position : in Cursor;
New_Item : in Element_Type);
If Position equals
No_Element, then Constraint_Error is propagated; if Position does not
designate an element in Container, then Program_Error is propagated.
Otherwise Replace_Element assigns the value New_Item to the element designated
by Position.
procedure Query_Element
(Position : in Cursor;
Process : not null access procedure (Element : in Element_Type));
If Position equals
No_Element, then Constraint_Error is propagated. Otherwise, Query_Element
calls Process.all with the element designated by Position as the
argument. Program_Error is propagated if Process.all tampers with
the elements of Container. Any exception raised by Process.all
is propagated.
procedure Update_Element
(Container : in out List;
Position : in Cursor;
Process : not null access procedure (Element : in out Element_Type));
If Position equals No_Element, then Constraint_Error
is propagated; if Position does not designate an element in Container,
then Program_Error is propagated. Otherwise Update_Element calls Process.all
with the element designated by Position as the argument. Program_Error
is propagated if Process.all tampers with the elements of Container.
Any exception raised by Process.all is propagated.
If Element_Type
is unconstrained and definite, then the actual Element parameter of Process.all
shall be unconstrained.
procedure Move (Target : in out List;
Source : in out List);
If Target denotes
the same object as Source, then Move has no effect. Otherwise, Move first
calls Clear (Target). Then, the nodes in Source are moved to Target (in
the original order). The length of Target is set to the length of Source,
and the length of Source is set to 0.
procedure Insert (Container : in out List;
Before : in Cursor;
New_Item : in Element_Type;
Count : in Count_Type := 1);
If Before is not
No_Element, and does not designate an element in Container, then Program_Error
is propagated. Otherwise, Insert inserts Count copies of New_Item prior
to the element designated by Before. If Before equals No_Element, the
new elements are inserted after the last node (if any). Any exception
raised during allocation of internal storage is propagated, and Container
is not modified.
procedure Insert (Container : in out List;
Before : in Cursor;
New_Item : in Element_Type;
Position : out Cursor;
Count : in Count_Type := 1);
If Before is not
No_Element, and does not designate an element in Container, then Program_Error
is propagated. Otherwise, Insert allocates Count copies of New_Item,
and inserts them prior to the element designated by Before. If Before
equals No_Element, the new elements are inserted after the last element
(if any). Position designates the first newly-inserted element. Any exception
raised during allocation of internal storage is propagated, and Container
is not modified.
procedure Insert (Container : in out List;
Before : in Cursor;
Position : out Cursor;
Count : in Count_Type := 1);
If Before is not
No_Element, and does not designate an element in Container, then Program_Error
is propagated. Otherwise, Insert inserts Count new elements prior to
the element designated by Before. If Before equals No_Element, the new
elements are inserted after the last node (if any). The new elements
are initialized by default (see
3.3.1). Any
exception raised during allocation of internal storage is propagated,
and Container is not modified.
procedure Prepend (Container : in out List;
New_Item : in Element_Type;
Count : in Count_Type := 1);
Equivalent to Insert
(Container, First (Container), New_Item, Count).
procedure Append (Container : in out List;
New_Item : in Element_Type;
Count : in Count_Type := 1);
Equivalent to Insert
(Container, No_Element, New_Item, Count).
procedure Delete (Container : in out List;
Position : in out Cursor;
Count : in Count_Type := 1);
If Position equals
No_Element, then Constraint_Error is propagated. If Position does not
designate an element in Container, then Program_Error is propagated.
Otherwise Delete removes (from Container) Count elements starting at
the element designated by Position (or all of the elements starting at
Position if there are fewer than Count elements starting at Position).
Finally, Position is set to No_Element.
procedure Delete_First (Container : in out List;
Count : in Count_Type := 1);
Equivalent to Delete
(Container, First (Container), Count).
procedure Delete_Last (Container : in out List;
Count : in Count_Type := 1);
If Length (Container)
<= Count then Delete_Last is equivalent to Clear (Container). Otherwise
it removes the last Count nodes from Container.
procedure Reverse_Elements (Container : in out List);
Reorders the elements
of Container in reverse order.
procedure Swap (Container : in out List;
I, J : in Cursor);
If either I or J
is No_Element, then Constraint_Error is propagated. If either I or J
do not designate an element in Container, then Program_Error is propagated.
Otherwise, Swap exchanges the values of the elements designated by I
and J.
procedure Swap_Links (Container : in out List;
I, J : in Cursor);
If either I or J
is No_Element, then Constraint_Error is propagated. If either I or J
do not designate an element in Container, then Program_Error is propagated.
Otherwise, Swap_Links exchanges the nodes designated by I and J.
procedure Splice (Target : in out List;
Before : in Cursor;
Source : in out List);
If Before is not
No_Element, and does not designate an element in Target, then Program_Error
is propagated. Otherwise, if Source denotes the same object as Target,
the operation has no effect. Otherwise, Splice reorders elements such
that they are removed from Source and moved to Target, immediately prior
to Before. If Before equals No_Element, the nodes of Source are spliced
after the last node of Target. The length of Target is incremented by
the number of nodes in Source, and the length of Source is set to 0.
procedure Splice (Target : in out List;
Before : in Cursor;
Source : in out List;
Position : in out Cursor);
If Position is No_Element
then Constraint_Error is propagated. If Before does not equal No_Element,
and does not designate an element in Target, then Program_Error is propagated.
If Position does not equal No_Element, and does not designate a node
in Source, then Program_Error is propagated. If Source denotes the same
object as Target, then there is no effect if Position equals Before,
else the element designated by Position is moved immediately prior to
Before, or, if Before equals No_Element, after the last element. In both
cases, Position and the length of Target are unchanged. Otherwise the
element designated by Position is removed from Source and moved to Target,
immediately prior to Before, or, if Before equals No_Element, after the
last element of Target. The length of Target is incremented, the length
of Source is decremented, and Position is updated to represent an element
in Target.
procedure Splice (Container: in out List;
Before : in Cursor;
Position : in Cursor);
If Position is No_Element
then Constraint_Error is propagated. If Before does not equal No_Element,
and does not designate an element in Container, then Program_Error is
propagated. If Position does not equal No_Element, and does not designate
a node in Container, then Program_Error is propagated. If Position equals
Before there is no effect. Otherwise, the element designated by Position
is moved immediately prior to Before, or, if Before equals No_Element,
after the last element. The length of Container is unchanged.
function First (Container : List) return Cursor;
If Container is
empty, First returns the value No_Element. Otherwise it returns a cursor
that designates the first node in Container.
function First_Element (Container : List) return Element_Type;
Equivalent to Element
(First (Container)).
function Last (Container : List) return Cursor;
If Container is
empty, Last returns the value No_Element. Otherwise it returns a cursor
that designates the last node in Container.
function Last_Element (Container : List) return Element_Type;
Equivalent to Element
(Last (Container)).
function Next (Position : Cursor) return Cursor;
If Position equals
No_Element or designates the last element of the container, then Next
returns the value No_Element. Otherwise, it returns a cursor that designates
the successor of the element designated by Position.
function Previous (Position : Cursor) return Cursor;
If Position equals
No_Element or designates the first element of the container, then Previous
returns the value No_Element. Otherwise, it returns a cursor that designates
the predecessor of the element designated by Position.
procedure Next (Position : in out Cursor);
Equivalent to Position
:= Next (Position).
procedure Previous (Position : in out Cursor);
Equivalent to Position
:= Previous (Position).
function Find (Container : List;
Item : Element_Type;
Position : Cursor := No_Element)
return Cursor;
If Position is not
No_Element, and does not designate an element in Container, then Program_Error
is propagated. Find searches the elements of Container for an element
equal to Item (using the generic formal equality operator). The search
starts at the element designated by Position, or at the first element
if Position equals No_Element. It proceeds towards Last (Container).
If no equal element is found, then Find returns No_Element. Otherwise,
it returns a cursor designating the first equal element encountered.
function Reverse_Find (Container : List;
Item : Element_Type;
Position : Cursor := No_Element)
return Cursor;
If Position is not
No_Element, and does not designate an element in Container, then Program_Error
is propagated. Find searches the elements of Container for an element
equal to Item (using the generic formal equality operator). The search
starts at the element designated by Position, or at the last element
if Position equals No_Element. It proceeds towards First (Container).
If no equal element is found, then Reverse_Find returns No_Element. Otherwise,
it returns a cursor designating the first equal element encountered.
function Contains (Container : List;
Item : Element_Type) return Boolean;
Equivalent to Find
(Container, Item) /= No_Element.
function Has_Element (Position : Cursor) return Boolean;
Returns True if
Position designates an element, and returns False otherwise.
procedure Iterate
(Container : in List;
Process : not null access procedure (Position : in Cursor));
Iterate calls Process.all
with a cursor that designates each node in Container, starting with the
first node and moving the cursor as per the Next function. Program_Error
is propagated if Process.all tampers with the cursors of Container.
Any exception raised by Process.all is propagated.
procedure Reverse_Iterate
(Container : in List;
Process : not null access procedure (Position : in Cursor));
Iterates over the
nodes in Container as per Iterate, except that elements are traversed
in reverse order, starting with the last node and moving the cursor as
per the Previous function.
The actual function for the generic formal function
"<" of Generic_Sorting is expected to return the same value
each time it is called with a particular pair of element values. It should
define a strict ordering relationship, that is, be irreflexive, asymmetric,
and transitive; it should not modify Container. If the actual for "<"
behaves in some other manner, the behavior of the subprograms of Generic_Sorting
are unspecified. How many times the subprograms of Generic_Sorting call
"<" is unspecified.
function Is_Sorted (Container : List) return Boolean;
Returns True if
the elements are sorted smallest first as determined by the generic formal
"<" operator; otherwise, Is_Sorted returns False. Any exception
raised during evaluation of "<" is propagated.
procedure Sort (Container : in out List);
Reorders the nodes
of Container such that the elements are sorted smallest first as determined
by the generic formal "<" operator provided. The sort is
stable. Any exception raised during evaluation of "<" is
propagated.
procedure Merge (Target : in out List;
Source : in out List);
Merge removes elements
from Source and inserts them into Target; afterwards, Target contains
the union of the elements that were initially in Source and Target; Source
is left empty. If Target and Source are initially sorted smallest first,
then Target is ordered smallest first as determined by the generic formal
"<" operator; otherwise, the order of elements in Target
is unspecified. Any exception raised during evaluation of "<"
is propagated.
Bounded (Run-Time) Errors
Calling Merge in an instance
of Generic_Sorting with either Source or Target not ordered smallest
first using the provided generic formal "<" operator is
a bounded error. Either Program_Error is raised after Target is updated
as described for Merge, or the operation works as defined.
Erroneous Execution
A Cursor value is
invalid if any of the following have occurred since it was created:
The list that contains the element it designates
has been finalized;
The list that contains the element it designates
has been used as the Source or Target of a call to Move; or
The element it designates has been deleted.
The result of "=" or Has_Element is unspecified
if it is called with an invalid cursor parameter. Execution is erroneous
if any other subprogram declared in Containers.Doubly_Linked_Lists is
called with an invalid cursor parameter.
Implementation Requirements
No storage associated with a doubly-linked List
object shall be lost upon assignment or scope exit.
The execution of an
assignment_statement
for a list shall have the effect of copying the elements from the source
list object to the target list object.
Implementation Advice
Containers.Doubly_Linked_Lists should be implemented
similarly to a linked list. In particular, if N is the length
of a list, then the worst-case time complexity of Element, Insert with
Count=1, and Delete with Count=1 should be O(log N).
The worst-case time complexity of a call on procedure
Sort of an instance of Containers.Doubly_Linked_Lists.Generic_Sorting
should be O(N**2), and the average time complexity should
be better than O(N**2).
Move should not copy elements, and should minimize
copying of internal data structures.
If an exception is propagated from a list operation,
no storage should be lost, nor any elements removed from a list unless
specified by the operation.
44 Sorting a list never copies elements,
and is a stable sort (equal elements remain in the original order). This
is different than sorting an array or vector, which may need to copy
elements, and is probably not a stable sort.
Sponsored by Ada-Europe