Skip to content

Commit

Permalink
version bump; update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
barrust committed Nov 11, 2020
1 parent 187af43 commit 3ad7f0c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Current Version

### Version 0.1.8
* Added in-depth testing
* Fixed potential overflow issues

### Version 0.1.7
* Added count-min sketch merge functionality; thanks to [jonahharris](https://github.com/jonahharris)

Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# count-min-sketch

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![GitHub release](https://img.shields.io/github/v/release/barrust/count-min-sketch.svg)](https://github.com/barrust/count-min-sketch/releases)
[![Build Status](https://travis-ci.com/barrust/count-min-sketch.svg?branch=master)](https://travis-ci.com/barrust/count-min-sketch)
[![codecov](https://codecov.io/gh/barrust/count-min-sketch/branch/master/graph/badge.svg)](https://codecov.io/gh/barrust/count-min-sketch)


A Count-Min Sketch implementation in **C**.

Count-Min Sketch is a probabilistic data-structure that takes sub linear space
Expand Down Expand Up @@ -35,7 +42,7 @@ For a **python version**, please check out [pyprobables](https://github.com/barr
which has a binary compatible output.


## Main Features:
## Main Features
* Ability to add and remove elements from the Count-Min Sketch
* Increment or add `x` elements at once
* Decrement or remove `x` elements at once
Expand All @@ -51,6 +58,7 @@ error and confidence
* ***Mean-Min*** attempts to take bias into account; results are less
skewed upwards compared to the mean lookup
* Export and Import count-min sketch to file
* Ability to merge multiple count-min sketches together

## Future Enhancements
* add method to calculate the possible bias (?)
Expand Down
2 changes: 1 addition & 1 deletion src/count_min_sketch.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*******************************************************************************
*** Author: Tyler Barrus
*** email: [email protected]
*** Version: 0.1.7
*** Version: 0.1.8
*** License: MIT 2017
*******************************************************************************/

Expand Down
4 changes: 2 additions & 2 deletions src/count_min_sketch.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
/*******************************************************************************
*** Author: Tyler Barrus
*** email: [email protected]
*** Version: 0.1.7
*** Version: 0.1.8
*** License: MIT 2017
*******************************************************************************/

#include <stdint.h>

#define COUNT_MIN_SKETCH_VERSION "0.1.7"
#define COUNT_MIN_SKETCH_VERSION "0.1.8"

/* CMS_ERROR is problematic in that it is difficult to check for the error
state since `INT_MIN` is a valid return value of the number of items
Expand Down

0 comments on commit 3ad7f0c

Please sign in to comment.