Skip to content

Commit

Permalink
add readme with example
Browse files Browse the repository at this point in the history
  • Loading branch information
lucastheis committed Oct 3, 2019
1 parent caf365f commit 64bb08d
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
@@ -0,0 +1,28 @@
Installation
============

pip install range-coder


Example
=======

```python
from range_coder import RangeEncoder, RangeDecoder, prob_to_cum_freq

data = [2, 0, 1, 0, 0, 0, 1, 2, 2]
prob = [0.5, 0.2, 0.3]

# convert probabilities to cumulative integer frequency table
cumFreq = prob_to_cum_freq(prob, resolution=128)

# encode data
encoder = RangeEncoder(filepath)
encoder.encode(data, cumFreq)
encoder.close()

# decode data
decoder = RangeDecoder(filepath)
dataRec = decoder.decode(len(data), cumFreq)
decoder.close()
```

0 comments on commit 64bb08d

Please sign in to comment.