Skip to content

Commit 7e77363

Browse files
committed
Remove use of C++ template paramter in FI description
1 parent bf5ef81 commit 7e77363

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/source/frequent_items.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Frequent Items
33

44
.. currentmodule:: datasketches
55

6-
This sketch is useful for tracking approximate frequencies of items of type `<T>` with optional associated counts `(<T> item, int count)`
7-
that are members of a multiset of such items.
6+
This sketch is useful for tracking approximate frequencies of items (``object`` or ``string``) with optional associated
7+
integer counts that are members of a multiset of such items.
88
The true frequency of an item is defined to be the sum of associated counts.
99

1010
This implementation provides the following capabilities:
@@ -23,18 +23,18 @@ The maximum map size is always a power of 2, defined through the variables ``lg_
2323

2424
The hash map starts at a very small size (8 entries) and grows as needed up to the specified maximum map size.
2525

26-
Excluding external space required for the item objects, the internal memory space usage of this sketch is `18 * ``mapSize`` bytes` (assuming 8 bytes for each reference),
26+
Excluding external space required for the item objects, the internal memory space usage of this sketch is ``18 * mapSize`` bytes (assuming 8 bytes for each reference),
2727
plus a small constant number of additional bytes.
28-
The internal memory space usage of this sketch will never exceed `18 * ``maxMapSize`` ` bytes, plus a small constant number of additional bytes.
28+
The internal memory space usage of this sketch will never exceed ``18 * maxMapSize`` bytes, plus a small constant number of additional bytes.
2929

3030
**Maximum Capacity of the Sketch**
3131

3232
The ``LOAD_FACTOR`` for the hash map is internally set at :math:`75\%`, which means at any time the map capacity of ``(item, count)`` pairs is ``mapCap = 0.75 * mapSize``.
33-
The maximum capacity of ``(item, count)`` pairs of the sketch is `maxMapCap = 0.75 * maxMapSize`.
33+
The maximum capacity of ``(item, count)`` pairs of the sketch is ``maxMapCap = 0.75 * maxMapSize``.
3434

3535
**Updating the sketch with ``(item, count)`` pairs**
3636

37-
If the item is found in the hash map, the mapped count field (the "counter") is incremented by the incoming count; otherwise, a new counter `"(item, count) pair"` is created.
37+
If the item is found in the hash map, the mapped count field (the "counter") is incremented by the incoming count; otherwise, a new counter ``(item, count)`` pair is created.
3838
If the number of tracked counters reaches the maximum capacity of the hash map, the sketch decrements all of the counters (by an approximately computed median)
3939
and removes any non-positive counters.
4040

0 commit comments

Comments
 (0)