Skip to content

Commit fa4eeee

Browse files
authored
Fix description of M parameter
The M parameter is used as the inverse of the false probability rate, so change its incorrect usage in two places.
1 parent f277d42 commit fa4eeee

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

bip-0158.mediawiki

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ one is able to select both Parameters independently, then more optimal values
8585
can be
8686
selected<ref>https://gist.github.com/sipa/576d5f09c3b86c3b1b75598d799fc845</ref>.
8787
Set membership queries against the hash outputs will have a false positive rate
88-
of <code>M</code>. To avoid integer overflow, the number of items <code>N</code>
88+
of <code>1 / M</code>. To avoid integer overflow, the number of items <code>N</code>
8989
MUST be <2^32 and <code>M</code> MUST be <2^32.
9090

9191
The items are first passed through the pseudorandom function ''SipHash'', which
@@ -189,7 +189,7 @@ golomb_decode(stream, P: uint) -> uint64:
189189
A GCS is constructed from four parameters:
190190
* <code>L</code>, a vector of <code>N</code> raw items
191191
* <code>P</code>, the bit parameter of the Golomb-Rice coding
192-
* <code>M</code>, the target false positive rate
192+
* <code>M</code>, the inverse of the target false positive rate
193193
* <code>k</code>, the 128-bit key used to randomize the SipHash outputs
194194
195195
The result is a byte vector with a minimum size of <code>N * (P + 1)</code>

0 commit comments

Comments
 (0)