CardinalityKit

Documentation

HTML documentation pages for CardinalityKit algorithms and concepts.

Files

fundamentals.html

Core concepts and mathematical foundations of cardinality estimation algorithms.

hyperloglog.html

Detailed documentation of the HyperLogLog algorithm, including:

hyperreal.html

Detailed documentation of the HyperReal algorithm, including:

extended-algorithms.html

Documentation for extended algorithms with attribute tracking:

panel-conversion.html

Guide for converting sample/panel data to population estimates:

algorithm-evolution.html

Historical evolution of cardinality estimation algorithms from Flajolet-Martin to HyperReal.

applications.html

Real-world applications and use cases for cardinality estimation.

implementation.html

Implementation details and best practices.

package.html

Package structure and API reference.

simulations.html

Documentation of simulation experiments and results.

sketch-operations.html

Operations on sketches including merging and serialization.

Viewing Documentation

Open any HTML file in a web browser:

open documentation/fundamentals.html

Or start a local server:

cd documentation
python -m http.server 8000
# Visit http://localhost:8000

Style

All documentation uses: