The Generic Package Containers.Bounded_Multiway_Trees
Author: JTC1/SC22/WG9/ARG, by Randall Brukardt, ARG Editor

Ada Reference Manual — Legal Information

# A.18.25 The Generic Package Containers.Bounded_Multiway_Trees

1/3
The language-defined generic package Containers.Bounded_Multiway_Trees provides a private type Tree and a set of operations. It provides the same operations as the package Containers.Multiway_Trees (see A.18.10), with the difference that the maximum storage is bounded.

#### Static Semantics

2/3
The declaration of the generic library package Containers.Bounded_Multiway_Trees has the same contents and semantics as Containers.Multiway_Trees except:
3/3
The pragma Preelaborate is replaced with pragma Pure.
4/3
The type Tree is declared with a discriminant that specifies the capacity (maximum number of elements) as follows:
5/3
type Tree (Capacity : Count_Type) is tagged private;
6/3
The type Tree needs finalization if and only if type Element_Type needs finalization.
7/3
The allocation of internal storage includes a check that the capacity is not exceeded, and Capacity_Error is raised if this check fails.
8/3
In procedure Assign, if Source length is greater than Target capacity, then Capacity_Error is propagated.
9/3
Function Copy is declared as follows:
10/3
function Copy (Source : Tree; Capacity : Count_Type := 0)
return List;
11/3
If Capacity is 0, then the tree capacity is the count of Source; if Capacity is equal to or greater than Source.Count, the tree capacity equals the value of the Capacity parameter; otherwise, the operation propagates Capacity_Error.
12/3
In the five-parameter procedure Splice_Subtree, if Source is not the same object as Target, and if the sum of Target.Count and Subtree_Node_Count (Position) is greater than Target.Capacity, then Splice_Subtree propagates Capacity_Error.
13/3
In the five-parameter procedure Splice_Children, if Source is not the same object as Target, and if the sum of Target.Count and Subtree_Node_Count (Source_Parent)-1 is greater than Target.Capacity, then Splice_Children propagates Capacity_Error.

#### Bounded (Run-Time) Errors

14/3
It is a bounded error to assign from a bounded tree object while tampering with elements or cursors of that object is prohibited. Either Program_Error is raised by the assignment, execution proceeds with the target object prohibiting tampering with elements or cursors, or execution proceeds normally.

#### Erroneous Execution

15/3
When a bounded tree object T is finalized, if tampering with cursors is prohibited for T other than due to an assignment from another tree, then execution is erroneous.

#### Implementation Requirements

16/3
For each instance of Containers.Multiway_Trees and each instance of Containers.Bounded_Multiway_Trees, if the two instances meet the following conditions, then the output generated by the Tree'Output or Tree'Write subprograms of either instance shall be readable by the Tree'Input or Tree'Read of the other instance, respectively:
17/3
the Element_Type parameters of the two instances are statically matching subtypes of the same type; and
18/3
the output generated by Element_Type'Output or Element_Type'Write is readable by Element_Type'Input or Element_Type'Read, respectively (where Element_Type denotes the type of the two actual Element_Type parameters).

#### Implementation Advice

19/3
Bounded tree objects should be implemented without implicit pointers or dynamic allocation.
20/3
The implementation advice for procedure Move to minimize copying does not apply.

Ada 2005 and 2012 Editions sponsored in part by Ada-Europe