Skip to content

Commit c0fdd91

Browse files
committed
Improved descriptions
KImproved the descriptionsof procedures and their arguments in a number of ways 1. Replaced 'a' with 'the' at a number of locations 2. Replaced 'chaining_hash_map_type with 'hash_map_type' at one location. 3. Replaced 'probes' with 'slots' int the description of 'num_slots. [ticket: X]
1 parent fdd7c92 commit c0fdd91

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

doc/specs/stdlib_hashmaps.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,7 +1314,7 @@ offsets of slot entries from their slot index
13141314

13151315
### Specifications of the `stdlib_hashmaps` procedures
13161316

1317-
#### `calls` - Returns the number of calls on a hash map
1317+
#### `calls` - Returns the number of calls on the hash map
13181318

13191319
##### Status
13201320

@@ -1361,7 +1361,7 @@ The result will be the number of procedure calls on the hash map.
13611361
```
13621362

13631363

1364-
#### `entries` - Returns the number of entries in a hash map
1364+
#### `entries` - Returns the number of entries in the hash map
13651365

13661366
##### Status
13671367

@@ -1442,7 +1442,8 @@ Subroutine
14421442

14431443
`exists` (optional): shall be a variable of type logical. It is an
14441444
`intent(out)` argument. If `.true.` an entry with the given `key`
1445-
exists in the map, if `.false.` `other` is undefined.
1445+
exists in the map and `other` is defined. If `.false.` `other` is
1446+
undefined.
14461447

14471448
##### Example
14481449

@@ -1495,7 +1496,7 @@ Experimental
14951496

14961497
##### Description
14971498

1498-
Initializes a `chaining_hashmap_type` object.
1499+
Initializes a `hashmap_type` object.
14991500

15001501
##### Syntax
15011502

@@ -1565,7 +1566,7 @@ Experimental
15651566
##### Description
15661567

15671568
Returns the ratio of the number of entries relative to the number of
1568-
slots in a hash map.
1569+
slots in the hash map.
15691570

15701571
##### Syntax
15711572

@@ -1643,7 +1644,7 @@ entry.
16431644
value indicates that an entry with the value of `key` already exists
16441645
and the entry was not entered into the map, a `.false.` value indicates
16451646
that `key` was not present in the map and the entry was added to the
1646-
table.
1647+
map.
16471648

16481649
* If `key` is already present in `map` then the presence of `other`
16491650
is ignored.
@@ -1677,7 +1678,7 @@ Experimental
16771678

16781679
##### Description
16791680

1680-
Returns the total number of table probes on a hash map
1681+
Returns the total number of table probes on the hash map.
16811682

16821683
##### Syntax
16831684

@@ -1717,7 +1718,7 @@ rehashing.
17171718
end program demo_probes
17181719
```
17191720

1720-
#### `num_slots` - returns the number of hash map probes
1721+
#### `num_slots` - returns the number of hash map slots.
17211722

17221723
##### Status
17231724

@@ -1773,7 +1774,7 @@ Experimental
17731774

17741775
##### Description
17751776

1776-
Changes the hashing function for the table entries to that of `hasher`.
1777+
Changes the hashing function for the map entries to that of `hasher`.
17771778

17781779
##### Syntax
17791780

@@ -1821,7 +1822,7 @@ Experimental
18211822

18221823
##### Description
18231824

1824-
Removes an entry from a hash map, `map`.
1825+
Removes an entry from the hash map, `map`.
18251826

18261827
##### Syntax
18271828

@@ -1846,7 +1847,7 @@ to be removed.
18461847
logical. It is an `intent(out)` argument. If present with the value
18471848
`.true.` the entry existed
18481849
in the map before removal, if `.false.` the entry was not present to be
1849-
removed.
1850+
removed and the map is unchanged.
18501851

18511852
##### Example
18521853

@@ -1878,7 +1879,8 @@ Experimental
18781879

18791880
##### Description
18801881

1881-
Replaces the other data for the entry with the key value, `key`.
1882+
Replaces the other data in the map for the entry with the key value,
1883+
`key`.
18821884

18831885
##### Syntax
18841886

@@ -1905,7 +1907,7 @@ the other data for the entry with the key value, `key`.
19051907

19061908
`exists` (optional): shall be a scalar variable of type default
19071909
logical. It is an `intent(out)` argument. If present with the value
1908-
`.true.` an entry with that key existed in the map and its `other`
1910+
`.true.` an entry with that `key` existed in the map and its `other`
19091911
data was replaced, otherwise if `exists` is `.false.` the entry did
19101912
not exist and nothing was done.
19111913

@@ -1942,7 +1944,7 @@ Experimental
19421944

19431945
##### Description
19441946

1945-
Returns the total number of slots on a hash map
1947+
Returns the total number of bits used to address the hash map slots.
19461948

19471949
##### Syntax
19481950

0 commit comments

Comments
 (0)