HllConfig

class aerospike_sdk.hll_config.HllConfig[source]

Bases: object

Configuration describing an HLL bin’s index and minhash bit widths.

Used as input to hll_init() and hll_add() to size a new sketch, and returned from a hll_describe() round trip via get_hll_config().

Parameters:
  • index_bit_count (int) – Number of index bits — controls register count and cardinality accuracy. Valid range is 4 to 16 inclusive.

  • min_hash_bit_count (int) – Number of minhash bits, or -1 for no minhash. Valid range when set is 4 to 51 inclusive. index_bit_count + min_hash_bit_count must not exceed 64.

Example

>>> config = HllConfig.of(14)
>>> config.index_bit_count
14
>>> config.min_hash_bit_count
-1
>>> with_minhash = HllConfig.of(12, 20)
>>> with_minhash.min_hash_bit_count
20

See also

get_hll_config():

Construct an HllConfig from a hll_describe() result.

index_bit_count: int
min_hash_bit_count: int
static of(index_bit_count, min_hash_bit_count=-1)[source]

Build an HllConfig.

Parameters:
  • index_bit_count (int) – Index bits, 4–16 inclusive.

  • min_hash_bit_count (int) – Minhash bits, 4–51 inclusive, or -1 for no minhash.

Return type:

HllConfig

Returns:

A frozen HllConfig value.

Example

>>> HllConfig.of(14)
HllConfig(index_bit_count=14, min_hash_bit_count=-1)
__init__(index_bit_count, min_hash_bit_count=-1)