Skip to content

Commit ba1ccfa

Browse files
committed
comments.
1 parent 8e6679c commit ba1ccfa

3 files changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,11 @@ short arrays are unreliable.)
222222

223223
## I used your code and I get segmentation faults
224224

225-
Our code is thoroughly tested, but some experimental schemes can overwrite
226-
in the receiving buffer (deliberately). This is a research library not
227-
all schemes are meant for production use. *Please review carefully the
228-
code prior to using it.*
225+
Our code is thoroughly tested.
226+
227+
Some experimental schemes can overwrite in the receiving buffer (deliberately).
228+
These includes Simple 9 and Simple 16 (which we recovered from the inventor's
229+
implementations). These limitations could be fixed (pull request invited).
229230

230231
One common issue is that people do not provide large enough buffers.
231232
Some schemes can have such small compression rates that the compressed data

headers/simple16.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
* Fabrizio Silvestri <fabrizio.silvestri_at_isti.cnr.it>
88
* Rossano Venturini <rossano.venturini_at_isti.cnr.it>
99
* which was available under the Apache License, Version 2.0.
10+
*
11+
* The Simple16 scheme may overflow the buffer when decoding.
12+
* This is a limitation of the original implementation..
1013
*/
1114

1215
#ifndef SIMPLE16_H_

headers/simple9.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
* Fabrizio Silvestri <fabrizio.silvestri_at_isti.cnr.it>
88
* Rossano Venturini <rossano.venturini_at_isti.cnr.it>
99
* which was available under the Apache License, Version 2.0.
10+
*
11+
* The Simple9 scheme may overflow the buffer when decoding.
12+
* This is a limitation of the original implementation..
1013
*/
1114
#ifndef SIMPLE9_H_
1215
#define SIMPLE9_H_

0 commit comments

Comments
 (0)