facebook/zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

avoid duplicate code comments

Browse Source 
when a function is decribed in hist.h,
do not describe it again in hist.c
to avoid future doc synchronization issues.
This commit is contained in:
Yann Collet 2018-06-14 19:47:05 -04:00
parent 78e5e2887e
commit 6901c94cd6
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/compress/hist.c
View File

@ -46,14 +46,6 @@ unsigned HIST_isError(size_t code) { return ERR_isError(code); }
/*-************************************************************** /*-**************************************************************
* Histogram functions * Histogram functions
****************************************************************/ ****************************************************************/
/*! HIST_count_simple :
Counts byte values within `src`, storing histogram into table `count`.
Doesn't use any additional memory, very limited stack usage.
But unsafe : doesn't check that all values within `src` fit into `count`.
For this reason, prefer using a table `count` of size 256.
@return : count of most numerous element.
this function doesn't produce any error (i.e. it must succeed).
*/
unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr, unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr,
const void* src, size_t srcSize) const void* src, size_t srcSize)
{ {
@ -83,7 +75,10 @@ unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr,
/* HIST_count_parallel_wksp() : /* HIST_count_parallel_wksp() :
* Same as HIST_count_parallel(), but using an externally provided scratch buffer. * store histogram into 4 intermediate tables, recombined at the end.
* this design makes better use of OoO cpus,
* and is noticeably faster when some values are heavily repeated.
* But it needs some additional workspace for intermediate tables.
* `workSpace` size must be a table of size >= HIST_WKSP_SIZE_U32. * `workSpace` size must be a table of size >= HIST_WKSP_SIZE_U32.
* @return : largest histogram frequency, * @return : largest histogram frequency,
* or an error code (notably when histogram would be larger than *maxSymbolValuePtr). */ * or an error code (notably when histogram would be larger than *maxSymbolValuePtr). */

8
lib/compress/hist.h
View File

@ -81,10 +81,12 @@ size_t HIST_countFast_wksp(unsigned* count, unsigned* maxSymbolValuePtr,
unsigned* workSpace); unsigned* workSpace);
/*! HIST_count_simple() : /*! HIST_count_simple() :
* Same as HIST_countFast(), but does not use any additional memory (not even on stack). * Same as HIST_countFast(), this function is unsafe,
* This function is unsafe, and will segfault if any value within `src` is `> *maxSymbolValuePtr`. * and will segfault if any value within `src` is `> *maxSymbolValuePtr`.
* It is also a bit slower for large inputs. * It is also a bit slower for large inputs.
* This function doesn't produce any error (i.e. it must succeed). * However, it does not need any additional memory (not even on stack).
* @return : count of the most frequent symbol.
* Note this function doesn't produce any error (i.e. it must succeed).
*/ */
unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr, unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr,
const void* src, size_t srcSize); const void* src, size_t srcSize);