Annotated Ada Reference ManualLegal Information
Contents   Index   References   Search   Previous   Next 

 A.18.22 The Generic Package Containers.Bounded_Ordered_Maps

{AI05-0001-1} The language-defined generic package Containers.Bounded_Ordered_Maps provides a private type Map and a set of operations. It provides the same operations as the package Containers.Ordered_Maps (see A.18.6), with the difference that the maximum storage is bounded.

Static Semantics

{AI05-0001-1} The declaration of the generic library package Containers.Bounded_Ordered_Maps has the same contents and semantics as Containers.Ordered_Maps except:
The pragma Preelaborate is replaced with pragma Pure.
The type Map is declared with a discriminant that specifies the capacity (maximum number of elements) as follows: 
  type Map (Capacity : Count_Type) is tagged private;
The type Map needs finalization if and only if type Key_Type or type Element_Type needs finalization.
Implementation Note: {AI05-0212-1} The type Map 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 a new node 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.
The function Copy is replaced with: 
  function Copy (Source : Map;
                 Capacity : Count_Type := 0) return Map;
Returns a map with key/element pairs initialized from the values in Source. If Capacity is 0, then the map capacity is the length of Source; if Capacity is equal to or greater than the length of Source, the map capacity is the specified value; otherwise, the operation propagates Capacity_Error. 

Bounded (Run-Time) Errors

 {AI05-0160-1} {AI05-0265-1} It is a bounded error to use a bounded map if it was the target of an assignment_statement whose source was in the middle of an operation that prohibits tampering with elements [or cursors]. Either Program_Error is raised, or the operation proceeds as defined. 

Implementation Requirements

 {AI05-0184-1} {AI05-0264-1} For each instance of Containers.Ordered_Maps and each instance of Containers.Bounded_Ordered_Maps, if the two instances meet the following conditions, then the output generated by the Map'Output or Map'Write subprograms of either instance shall be readable by the Map'Input or Map'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); and
{AI05-0184-1} the preceding two conditions also hold for the Key_Type parameters of the instances. 

Implementation Advice

 {AI05-0001-1} Bounded map objects should be implemented without implicit pointers or dynamic allocation. 
 {AI05-0001-1} The implementation advice for procedure Move to minimize copying does not apply. 

Extensions to Ada 2005

{AI05-0001-1} {AI05-0160-1} {AI05-0184-1} The generic package Containers.Bounded_Ordered_Maps is new. 

Contents   Index   References   Search   Previous   Next 
Ada-Europe Ada 2005 and 2012 Editions sponsored in part by Ada-Europe