A.18.25 The Generic Package Containers.Bounded_Multiway_Trees
{
AI05-0136-1}
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
{
AI05-0136-1}
The declaration of the generic library package Containers.Bounded_Multiway_Trees
has the same contents and semantics as Containers.Multiway_Trees except:
The type Tree is
declared with a discriminant that specifies the capacity (maximum number
of elements) as follows:
type Tree (Capacity : Count_Type) is tagged private;
The type Tree needs finalization if and only if
type Element_Type needs finalization.
Implementation Note: {
AI05-0212-1}
The type Tree cannot depend on package Ada.Finalization unless the element
type depends on that package. The objects returned from the Iterator
and Reference functions probably do depend on package Ada.Finalization.
Restricted environments may need to avoid use of those functions and
their associated types.
The allocation of internal storage includes a check
that the capacity is not exceeded, and Capacity_Error is raised if this
check fails.
In procedure Assign, if Source length is greater
than Target capacity, then Capacity_Error is propagated.
Function Copy is
declared as follows:
{
AI12-0056-1}
function Copy (Source : Tree; Capacity : Count_Type := 0)
return Tree;
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.
{
AI05-0136-1}
{
AI05-0248-1}
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.
{
AI05-0136-1}
{
AI05-0248-1}
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
{
AI05-0160-1}
{
AI05-0265-1}
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.
Proof: Tampering with elements includes
tampering with cursors, so we only really need to talk about tampering
with elements here; we mention cursors for clarity.
Erroneous Execution
{
AI05-0265-1}
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.
Reason: This is a tampering event, but
since the implementation is not allowed to use Ada.Finalization, it is
not possible in a pure Ada implementation to detect this error. (There
is no Finalize routine that will be called that could make the check.)
Since the check probably cannot be made, the bad effects that could occur
(such as an iterator going into an infinite loop or accessing a nonexistent
element) cannot be prevented and we have to allow anything. We do allow
re-assigning an object that only prohibits tampering because it was copied
from another object as that cannot cause any negative effects.
Implementation Requirements
{
AI05-0184-1}
{
AI05-0264-1}
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:
{
AI05-0184-1}
{
AI05-0248-1}
the Element_Type parameters of the two instances are statically matching
subtypes of the same type; and
{
AI05-0184-1}
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
{
AI05-0136-1}
Bounded tree objects should be implemented without implicit pointers
or dynamic allocation.
Implementation Advice: Bounded tree objects
should be implemented without implicit pointers or dynamic allocation.
{
AI05-0136-1}
The implementation advice for procedure Move to minimize copying does
not apply.
Implementation Advice: The implementation
advice for procedure Move to minimize copying does not apply to bounded
trees.
Extensions to Ada 2005
Ada 2005 and 2012 Editions sponsored in part by Ada-Europe
