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

Ada Reference Manual — Legal Information

# A.18.23 The Generic Package Containers.Bounded_Hashed_Sets

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

#### Static Semantics

2/3
The declaration of the generic library package Containers.Bounded_Hashed_Sets has the same contents and semantics as Containers.Hashed_Sets except:
3/3
The pragma Preelaborate is replaced with pragma Pure.
4/3
The type Set is declared with discriminants that specify both the capacity (number of elements) and modulus (number of distinct hash values) of the hash table as follows:
5/3
type Set (Capacity : Count_Type;
Modulus : Hash_Type) is tagged private;
6/3
The type Set needs finalization if and only if type Element_Type needs finalization.
7/3
The description of Reserve_Capacity is replaced with:
8/3
If the specified Capacity is larger than the capacity of Container, then Reserve_Capacity propagates Capacity_Error. Otherwise, the operation has no effect.
9/3
An additional operation is added immediately following Reserve_Capacity:
10/3
function Default_Modulus (Capacity : Count_Type) return Hash_Type;
11/3
Default_Modulus returns an implementation-defined value for the number of distinct hash values to be used for the given capacity (maximum number of elements).
12/3
The function Copy is replaced with:
13/3
function Copy (Source : Set;
Capacity : Count_Type := 0;
Modulus : Hash_Type := 0) return Set;
14/3
Returns a set whose elements are initialized from the values in Source. If Capacity is 0, then the set capacity is the length of Source; if Capacity is equal to or greater than the length of Source, the set capacity is the value of the Capacity parameter; otherwise, the operation propagates Capacity_Error. If the Modulus argument is 0, then the set modulus is the value returned by a call to Default_Modulus with the set capacity as its argument; otherwise, the set modulus is the value of the Modulus parameter.

#### Bounded (Run-Time) Errors

15/3
It is a bounded error to assign from a bounded set 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

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

#### Implementation Requirements

17/3
For each instance of Containers.Hashed_Sets and each instance of Containers.Bounded_Hashed_Sets, if the two instances meet the following conditions, then the output generated by the Set'Output or Set'Write subprograms of either instance shall be readable by the Set'Input or Set'Read of the other instance, respectively:
18/3
the Element_Type parameters of the two instances are statically matching subtypes of the same type; and
19/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

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

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