Gecko [ denebpollux.com ]

Name	Size	Permission
GL	[ DIR ]	drwxr-xr-x
X11	[ DIR ]	drwxr-xr-x
arpa	[ DIR ]	drwxr-xr-x
asm	[ DIR ]	drwxr-xr-x
asm-generic	[ DIR ]	drwxr-xr-x
bind9	[ DIR ]	drwxr-xr-x
bits	[ DIR ]	drwxr-xr-x
c++	[ DIR ]	drwxr-xr-x
drm	[ DIR ]	drwxr-xr-x
e2p	[ DIR ]	drwxr-xr-x
et	[ DIR ]	drwxr-xr-x
event2	[ DIR ]	drwxr-xr-x
ext2fs	[ DIR ]	drwxr-xr-x
finclude	[ DIR ]	drwxr-xr-x
fontconfig	[ DIR ]	drwxr-xr-x
freetype2	[ DIR ]	drwxr-xr-x
fstrm	[ DIR ]	drwxr-xr-x
gdbm	[ DIR ]	drwxr-xr-x
gnu	[ DIR ]	drwxr-xr-x
google	[ DIR ]	drwxr-xr-x
gssapi	[ DIR ]	drwxr-xr-x
gssrpc	[ DIR ]	drwxr-xr-x
json-c	[ DIR ]	drwxr-xr-x
kadm5	[ DIR ]	drwxr-xr-x
krb5	[ DIR ]	drwxr-xr-x
libexslt	[ DIR ]	drwxr-xr-x
libltdl	[ DIR ]	drwxr-xr-x
libpng16	[ DIR ]	drwxr-xr-x
libxml2	[ DIR ]	drwxr-xr-x
libxslt	[ DIR ]	drwxr-xr-x
linux	[ DIR ]	drwxr-xr-x
lzma	[ DIR ]	drwxr-xr-x
misc	[ DIR ]	drwxr-xr-x
mtd	[ DIR ]	drwxr-xr-x
mysql	[ DIR ]	drwxr-xr-x
ncurses	[ DIR ]	drwxr-xr-x
ncursesw	[ DIR ]	drwxr-xr-x
net	[ DIR ]	drwxr-xr-x
netash	[ DIR ]	drwxr-xr-x
netatalk	[ DIR ]	drwxr-xr-x
netax25	[ DIR ]	drwxr-xr-x
neteconet	[ DIR ]	drwxr-xr-x
netinet	[ DIR ]	drwxr-xr-x
netipx	[ DIR ]	drwxr-xr-x
netiucv	[ DIR ]	drwxr-xr-x
netpacket	[ DIR ]	drwxr-xr-x
netrom	[ DIR ]	drwxr-xr-x
netrose	[ DIR ]	drwxr-xr-x
nfs	[ DIR ]	drwxr-xr-x
openssl	[ DIR ]	drwxr-xr-x
perf	[ DIR ]	drwxr-xr-x
protobuf-c	[ DIR ]	drwxr-xr-x
protocols	[ DIR ]	drwxr-xr-x
python2.7	[ DIR ]	drwxr-xr-x
python3.12	[ DIR ]	drwxr-xr-x
python3.6m	[ DIR ]	drwxr-xr-x
rdma	[ DIR ]	drwxr-xr-x
rpc	[ DIR ]	drwxr-xr-x
scsi	[ DIR ]	drwxr-xr-x
security	[ DIR ]	drwxr-xr-x
selinux	[ DIR ]	drwxr-xr-x
sepol	[ DIR ]	drwxr-xr-x
sound	[ DIR ]	drwxr-xr-x
sys	[ DIR ]	drwxr-xr-x
uuid	[ DIR ]	drwxr-xr-x
video	[ DIR ]	drwxr-xr-x
webp	[ DIR ]	drwxr-xr-x
xcb	[ DIR ]	drwxr-xr-x
xen	[ DIR ]	drwxr-xr-x
FlexLexer.h	6.73 KB	-rw-r--r--
a.out.h	4.25 KB	-rw-r--r--
aio.h	7.28 KB	-rw-r--r--
aliases.h	1.98 KB	-rw-r--r--
alloca.h	1.17 KB	-rw-r--r--
ar.h	1.69 KB	-rw-r--r--
argp.h	24.82 KB	-rw-r--r--
argz.h	5.91 KB	-rw-r--r--
assert.h	4.45 KB	-rw-r--r--
autosprintf.h	2.33 KB	-rw-r--r--
byteswap.h	1.37 KB	-rw-r--r--
bzlib.h	6.1 KB	-rw-r--r--
com_err.h	2.07 KB	-rw-r--r--
complex.h	7 KB	-rw-r--r--
cpio.h	2.21 KB	-rw-r--r--
cpuidle.h	844 B	-rw-r--r--
crypt.h	8.9 KB	-rw-r--r--
ctype.h	10.71 KB	-rw-r--r--
curses.h	97.29 KB	-rw-r--r--
cursesapp.h	6.62 KB	-rw-r--r--
cursesf.h	27.2 KB	-rw-r--r--
cursesm.h	19.22 KB	-rw-r--r--
cursesp.h	8.4 KB	-rw-r--r--
cursesw.h	48.55 KB	-rw-r--r--
cursslk.h	7.13 KB	-rw-r--r--
dbm.h	1.38 KB	-rw-r--r--
dirent.h	12.19 KB	-rw-r--r--
dlfcn.h	7.07 KB	-rw-r--r--
elf.h	170.73 KB	-rw-r--r--
endian.h	3.11 KB	-rw-r--r--
entities.h	4.81 KB	-rw-r--r--
envz.h	2.8 KB	-rw-r--r--
err.h	2.16 KB	-rw-r--r--
errno.h	1.64 KB	-rw-r--r--
error.h	1.99 KB	-rw-r--r--
eti.h	2.82 KB	-rw-r--r--
etip.h	9.47 KB	-rw-r--r--
evdns.h	1.97 KB	-rw-r--r--
event.h	2.68 KB	-rw-r--r--
evhttp.h	1.99 KB	-rw-r--r--
evrpc.h	1.97 KB	-rw-r--r--
evutil.h	1.74 KB	-rw-r--r--
execinfo.h	1.49 KB	-rw-r--r--
expat.h	43.24 KB	-rw-r--r--
expat_config.h	3.82 KB	-rw-r--r--
expat_external.h	5.89 KB	-rw-r--r--
fcntl.h	10.7 KB	-rw-r--r--
features.h	15.69 KB	-rw-r--r--
fenv.h	5.72 KB	-rw-r--r--
fmtmsg.h	3.16 KB	-rw-r--r--
fnmatch.h	2.24 KB	-rw-r--r--
form.h	18.17 KB	-rw-r--r--
fpu_control.h	3.5 KB	-rw-r--r--
fstab.h	3.04 KB	-rw-r--r--
fstrm.h	12.71 KB	-rw-r--r--
fts.h	8.18 KB	-rw-r--r--
ftw.h	5.13 KB	-rw-r--r--
gconv.h	3.99 KB	-rw-r--r--
gcrypt.h	68.71 KB	-rw-r--r--
gd.h	56.42 KB	-rw-r--r--
gd_color_map.h	478 B	-rw-r--r--
gd_errors.h	1.47 KB	-rw-r--r--
gd_io.h	3.05 KB	-rw-r--r--
gdbm.h	10.1 KB	-rw-r--r--
gdcache.h	2.83 KB	-rw-r--r--
gdfontg.h	553 B	-rw-r--r--
gdfontl.h	551 B	-rw-r--r--
gdfontmb.h	519 B	-rw-r--r--
gdfonts.h	515 B	-rw-r--r--
gdfontt.h	546 B	-rw-r--r--
gdfx.h	497 B	-rw-r--r--
gdpp.h	50.94 KB	-rw-r--r--
gelf.h	11.14 KB	-rw-r--r--
getopt.h	1.43 KB	-rw-r--r--
gettext-po.h	15.17 KB	-rw-r--r--
glob.h	6.46 KB	-rw-r--r--
gnu-versions.h	2.29 KB	-rw-r--r--
gnumake.h	2.84 KB	-rw-r--r--
gpg-error.h	66.29 KB	-rw-r--r--
gpgrt.h	66.29 KB	-rw-r--r--
grp.h	6.53 KB	-rw-r--r--
gshadow.h	4.42 KB	-rw-r--r--
gssapi.h	181 B	-rw-r--r--
iconv.h	1.81 KB	-rw-r--r--
idn-free.h	2.41 KB	-rw-r--r--
idn-int.h	20 B	-rw-r--r--
idna.h	3.48 KB	-rw-r--r--
ieee754.h	4.79 KB	-rw-r--r--
ifaddrs.h	2.77 KB	-rw-r--r--
inttypes.h	11.61 KB	-rw-r--r--
jconfig-64.h	2.17 KB	-rw-r--r--
jconfig.h	246 B	-rw-r--r--
jerror.h	14.73 KB	-rw-r--r--
jmorecfg.h	14.7 KB	-rw-r--r--
jpegint.h	15.22 KB	-rw-r--r--
jpeglib.h	48.71 KB	-rw-r--r--
kdb.h	67.66 KB	-rw-r--r--
keyutils.h	7.52 KB	-rw-r--r--
krad.h	8.72 KB	-rw-r--r--
krb5.h	402 B	-rw-r--r--
langinfo.h	17.43 KB	-rw-r--r--
lastlog.h	126 B	-rw-r--r--
libaio.h	8.73 KB	-rw-r--r--
libelf.h	19.84 KB	-rw-r--r--
libgen.h	1.35 KB	-rw-r--r--
libintl.h	4.47 KB	-rw-r--r--
limits.h	5.29 KB	-rw-r--r--
link.h	7.05 KB	-rw-r--r--
locale.h	7.49 KB	-rw-r--r--
ltdl.h	5.58 KB	-rw-r--r--
lzma.h	9.59 KB	-rw-r--r--
malloc.h	5.96 KB	-rw-r--r--
math.h	52.07 KB	-rw-r--r--
mcheck.h	2.38 KB	-rw-r--r--
memory.h	955 B	-rw-r--r--
menu.h	11.91 KB	-rw-r--r--
mntent.h	3.28 KB	-rw-r--r--
monetary.h	1.76 KB	-rw-r--r--
mqueue.h	3.67 KB	-rw-r--r--
nc_tparm.h	4.1 KB	-rw-r--r--
ncurses.h	97.29 KB	-rw-r--r--
ncurses_dll.h	4.18 KB	-rw-r--r--
ndbm.h	2.4 KB	-rw-r--r--
netdb.h	27.44 KB	-rw-r--r--
nl_types.h	1.71 KB	-rw-r--r--
nlist.h	1.56 KB	-rw-r--r--
nss.h	1.83 KB	-rw-r--r--
obstack.h	20.81 KB	-rw-r--r--
panel.h	4.03 KB	-rw-r--r--
paths.h	2.91 KB	-rw-r--r--
pcre.h	30.97 KB	-rw-r--r--
pcre2.h	43.75 KB	-rw-r--r--
pcre2posix.h	5.67 KB	-rw-r--r--
pcre_scanner.h	6.45 KB	-rw-r--r--
pcre_stringpiece.h	6.16 KB	-rw-r--r--
pcrecpp.h	25.91 KB	-rw-r--r--
pcrecpparg.h	6.62 KB	-rw-r--r--
pcreposix.h	5.32 KB	-rw-r--r--
png.h	140.77 KB	-rw-r--r--
pngconf.h	22.31 KB	-rw-r--r--
pnglibconf.h	7.39 KB	-rw-r--r--
poll.h	22 B	-rw-r--r--
pr29.h	2.07 KB	-rw-r--r--
printf.h	6.64 KB	-rw-r--r--
proc_service.h	3.39 KB	-rw-r--r--
profile.h	11.87 KB	-rw-r--r--
pthread.h	40.3 KB	-rw-r--r--
pty.h	1.53 KB	-rw-r--r--
punycode.h	9.16 KB	-rw-r--r--
pwd.h	6.01 KB	-rw-r--r--
re_comp.h	962 B	-rw-r--r--
regex.h	24.14 KB	-rw-r--r--
regexp.h	1.41 KB	-rw-r--r--
resolv.h	11.87 KB	-rw-r--r--
sched.h	4.62 KB	-rw-r--r--
search.h	5.1 KB	-rw-r--r--
semaphore.h	2.34 KB	-rw-r--r--
setjmp.h	3.58 KB	-rw-r--r--
sgtty.h	1.31 KB	-rw-r--r--
shadow.h	5.34 KB	-rw-r--r--
signal.h	11.96 KB	-rw-r--r--
spawn.h	6.53 KB	-rw-r--r--
stab.h	264 B	-rw-r--r--
stdc-predef.h	2.24 KB	-rw-r--r--
stdint.h	8.27 KB	-rw-r--r--
stdio.h	29.46 KB	-rw-r--r--
stdio_ext.h	2.73 KB	-rw-r--r--
stdlib.h	34.82 KB	-rw-r--r--
string.h	17.17 KB	-rw-r--r--
stringprep.h	8.03 KB	-rw-r--r--
strings.h	4.64 KB	-rw-r--r--
syscall.h	25 B	-rw-r--r--
sysexits.h	5.11 KB	-rw-r--r--
syslog.h	24 B	-rw-r--r--
tar.h	3.7 KB	-rw-r--r--
term.h	40.22 KB	-rw-r--r--
term_entry.h	8.55 KB	-rw-r--r--
termcap.h	3.39 KB	-rw-r--r--
termio.h	214 B	-rw-r--r--
termios.h	3.51 KB	-rw-r--r--
tgmath.h	30.75 KB	-rw-r--r--
thread_db.h	15.65 KB	-rw-r--r--
threads.h	6.5 KB	-rw-r--r--
tic.h	13.32 KB	-rw-r--r--
tiff.h	35.14 KB	-rw-r--r--
tiffconf-64.h	3.35 KB	-rw-r--r--
tiffconf.h	250 B	-rw-r--r--
tiffio.h	22.68 KB	-rw-r--r--
tiffio.hxx	1.66 KB	-rw-r--r--
tiffvers.h	410 B	-rw-r--r--
time.h	10.12 KB	-rw-r--r--
tld.h	4.54 KB	-rw-r--r--
ttyent.h	2.44 KB	-rw-r--r--
uchar.h	1.95 KB	-rw-r--r--
ucontext.h	1.99 KB	-rw-r--r--
ulimit.h	1.55 KB	-rw-r--r--
unctrl.h	3.03 KB	-rw-r--r--
unistd.h	41.74 KB	-rw-r--r--
utime.h	1.47 KB	-rw-r--r--
utmp.h	3.15 KB	-rw-r--r--
utmpx.h	4 KB	-rw-r--r--
values.h	1.91 KB	-rw-r--r--
verto-module.h	6.48 KB	-rw-r--r--
verto.h	18.98 KB	-rw-r--r--
wait.h	22 B	-rw-r--r--
wchar.h	30.38 KB	-rw-r--r--
wctype.h	5.42 KB	-rw-r--r--
wordexp.h	2.44 KB	-rw-r--r--
zbuff.h	11.23 KB	-rw-r--r--
zconf.h	15.88 KB	-rw-r--r--
zdict.h	16.8 KB	-rw-r--r--
zlib.h	94 KB	-rw-r--r--
zstd.h	117.16 KB	-rw-r--r--
zstd_errors.h	3.66 KB	-rw-r--r--

Code Editor : zdict.h

/*
 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under both the BSD-style license (found in the
 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
 * in the COPYING file in the root directory of this source tree).
 * You may select, at your option, one of the above-listed licenses.
 */

#ifndef DICTBUILDER_H_001
#define DICTBUILDER_H_001

#if defined (__cplusplus)
extern "C" {
#endif

/*======  Dependencies  ======*/
#include <stddef.h>  /* size_t */

/* =====   ZDICTLIB_API : control library symbols visibility   ===== */
#ifndef ZDICTLIB_VISIBILITY
#  if defined(__GNUC__) && (__GNUC__ >= 4)
#    define ZDICTLIB_VISIBILITY __attribute__ ((visibility ("default")))
#  else
#    define ZDICTLIB_VISIBILITY
#  endif
#endif
#if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
#  define ZDICTLIB_API __declspec(dllexport) ZDICTLIB_VISIBILITY
#elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
#  define ZDICTLIB_API __declspec(dllimport) ZDICTLIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
#else
#  define ZDICTLIB_API ZDICTLIB_VISIBILITY
#endif

/*! ZDICT_trainFromBuffer():
 *  Train a dictionary from an array of samples.
 *  Redirect towards ZDICT_optimizeTrainFromBuffer_fastCover() single-threaded, with d=8, steps=4,
 *  f=20, and accel=1.
 *  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,
 *  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order.
 *  The resulting dictionary will be saved into `dictBuffer`.
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *  Note:  Dictionary training will fail if there are not enough samples to construct a
 *         dictionary, or if most of the samples are too small (< 8 bytes being the lower limit).
 *         If dictionary training fails, you should use zstd without a dictionary, as the dictionary
 *         would've been ineffective anyways. If you believe your samples would benefit from a dictionary
 *         please open an issue with details, and we can look into it.
 *  Note: ZDICT_trainFromBuffer()'s memory usage is about 6 MB.
 *  Tips: In general, a reasonable dictionary has a size of ~ 100 KB.
 *        It's possible to select smaller or larger size, just by specifying `dictBufferCapacity`.
 *        In general, it's recommended to provide a few thousands samples, though this can vary a lot.
 *        It's recommended that total size of all samples be about ~x100 times the target size of dictionary.
 */
ZDICTLIB_API size_t ZDICT_trainFromBuffer(void* dictBuffer, size_t dictBufferCapacity,
                                    const void* samplesBuffer,
                                    const size_t* samplesSizes, unsigned nbSamples);

/*======   Helper functions   ======*/
ZDICTLIB_API unsigned ZDICT_getDictID(const void* dictBuffer, size_t dictSize);  /**< extracts dictID; @return zero if error (not a valid dictionary) */
ZDICTLIB_API unsigned ZDICT_isError(size_t errorCode);
ZDICTLIB_API const char* ZDICT_getErrorName(size_t errorCode);

#ifdef ZDICT_STATIC_LINKING_ONLY

/* ====================================================================================
 * The definitions in this section are considered experimental.
 * They should never be used with a dynamic library, as they may change in the future.
 * They are provided for advanced usages.
 * Use them only in association with static linking.
 * ==================================================================================== */

typedef struct {
    int      compressionLevel;   /* optimize for a specific zstd compression level; 0 means default */
    unsigned notificationLevel;  /* Write log to stderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug; */
    unsigned dictID;             /* force dictID value; 0 means auto mode (32-bits random value) */
} ZDICT_params_t;

/*! ZDICT_cover_params_t:
 *  k and d are the only required parameters.
 *  For others, value 0 means default.
 */
typedef struct {
    unsigned k;                  /* Segment size : constraint: 0 < k : Reasonable range [16, 2048+] */
    unsigned d;                  /* dmer size : constraint: 0 < d <= k : Reasonable range [6, 16] */
    unsigned steps;              /* Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked */
    unsigned nbThreads;          /* Number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined */
    double splitPoint;           /* Percentage of samples used for training: Only used for optimization : the first nbSamples * splitPoint samples will be used to training, the last nbSamples * (1 - splitPoint) samples will be used for testing, 0 means default (1.0), 1.0 when all samples are used for both training and testing */
    unsigned shrinkDict;         /* Train dictionaries to shrink in size starting from the minimum size and selects the smallest dictionary that is shrinkDictMaxRegression% worse than the largest dictionary. 0 means no shrinking and 1 means shrinking  */
    unsigned shrinkDictMaxRegression; /* Sets shrinkDictMaxRegression so that a smaller dictionary can be at worse shrinkDictMaxRegression% worse than the max dict size dictionary. */
    ZDICT_params_t zParams;
} ZDICT_cover_params_t;

typedef struct {
    unsigned k;                  /* Segment size : constraint: 0 < k : Reasonable range [16, 2048+] */
    unsigned d;                  /* dmer size : constraint: 0 < d <= k : Reasonable range [6, 16] */
    unsigned f;                  /* log of size of frequency array : constraint: 0 < f <= 31 : 1 means default(20)*/
    unsigned steps;              /* Number of steps : Only used for optimization : 0 means default (40) : Higher means more parameters checked */
    unsigned nbThreads;          /* Number of threads : constraint: 0 < nbThreads : 1 means single-threaded : Only used for optimization : Ignored if ZSTD_MULTITHREAD is not defined */
    double splitPoint;           /* Percentage of samples used for training: Only used for optimization : the first nbSamples * splitPoint samples will be used to training, the last nbSamples * (1 - splitPoint) samples will be used for testing, 0 means default (0.75), 1.0 when all samples are used for both training and testing */
    unsigned accel;              /* Acceleration level: constraint: 0 < accel <= 10, higher means faster and less accurate, 0 means default(1) */
    unsigned shrinkDict;         /* Train dictionaries to shrink in size starting from the minimum size and selects the smallest dictionary that is shrinkDictMaxRegression% worse than the largest dictionary. 0 means no shrinking and 1 means shrinking  */
    unsigned shrinkDictMaxRegression; /* Sets shrinkDictMaxRegression so that a smaller dictionary can be at worse shrinkDictMaxRegression% worse than the max dict size dictionary. */

ZDICT_params_t zParams;
} ZDICT_fastCover_params_t;

/*! ZDICT_trainFromBuffer_cover():
 *  Train a dictionary from an array of samples using the COVER algorithm.
 *  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,
 *  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order.
 *  The resulting dictionary will be saved into `dictBuffer`.
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *          See ZDICT_trainFromBuffer() for details on failure modes.
 *  Note: ZDICT_trainFromBuffer_cover() requires about 9 bytes of memory for each input byte.
 *  Tips: In general, a reasonable dictionary has a size of ~ 100 KB.
 *        It's possible to select smaller or larger size, just by specifying `dictBufferCapacity`.
 *        In general, it's recommended to provide a few thousands samples, though this can vary a lot.
 *        It's recommended that total size of all samples be about ~x100 times the target size of dictionary.
 */
ZDICTLIB_API size_t ZDICT_trainFromBuffer_cover(
          void *dictBuffer, size_t dictBufferCapacity,
    const void *samplesBuffer, const size_t *samplesSizes, unsigned nbSamples,
          ZDICT_cover_params_t parameters);

/*! ZDICT_optimizeTrainFromBuffer_cover():
 * The same requirements as above hold for all the parameters except `parameters`.
 * This function tries many parameter combinations and picks the best parameters.
 * `*parameters` is filled with the best parameters found,
 * dictionary constructed with those parameters is stored in `dictBuffer`.
 *
 * All of the parameters d, k, steps are optional.
 * If d is non-zero then we don't check multiple values of d, otherwise we check d = {6, 8}.
 * if steps is zero it defaults to its default value.
 * If k is non-zero then we don't check multiple values of k, otherwise we check steps values in [50, 2000].
 *
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *          On success `*parameters` contains the parameters selected.
 *          See ZDICT_trainFromBuffer() for details on failure modes.
 * Note: ZDICT_optimizeTrainFromBuffer_cover() requires about 8 bytes of memory for each input byte and additionally another 5 bytes of memory for each byte of memory for each thread.
 */
ZDICTLIB_API size_t ZDICT_optimizeTrainFromBuffer_cover(
          void* dictBuffer, size_t dictBufferCapacity,
    const void* samplesBuffer, const size_t* samplesSizes, unsigned nbSamples,
          ZDICT_cover_params_t* parameters);

/*! ZDICT_trainFromBuffer_fastCover():
 *  Train a dictionary from an array of samples using a modified version of COVER algorithm.
 *  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,
 *  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order.
 *  d and k are required.
 *  All other parameters are optional, will use default values if not provided
 *  The resulting dictionary will be saved into `dictBuffer`.
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *          See ZDICT_trainFromBuffer() for details on failure modes.
 *  Note: ZDICT_trainFromBuffer_fastCover() requires 6 * 2^f bytes of memory.
 *  Tips: In general, a reasonable dictionary has a size of ~ 100 KB.
 *        It's possible to select smaller or larger size, just by specifying `dictBufferCapacity`.
 *        In general, it's recommended to provide a few thousands samples, though this can vary a lot.
 *        It's recommended that total size of all samples be about ~x100 times the target size of dictionary.
 */
ZDICTLIB_API size_t ZDICT_trainFromBuffer_fastCover(void *dictBuffer,
                    size_t dictBufferCapacity, const void *samplesBuffer,
                    const size_t *samplesSizes, unsigned nbSamples,
                    ZDICT_fastCover_params_t parameters);

/*! ZDICT_optimizeTrainFromBuffer_fastCover():
 * The same requirements as above hold for all the parameters except `parameters`.
 * This function tries many parameter combinations (specifically, k and d combinations)
 * and picks the best parameters. `*parameters` is filled with the best parameters found,
 * dictionary constructed with those parameters is stored in `dictBuffer`.
 * All of the parameters d, k, steps, f, and accel are optional.
 * If d is non-zero then we don't check multiple values of d, otherwise we check d = {6, 8}.
 * if steps is zero it defaults to its default value.
 * If k is non-zero then we don't check multiple values of k, otherwise we check steps values in [50, 2000].
 * If f is zero, default value of 20 is used.
 * If accel is zero, default value of 1 is used.
 *
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *          On success `*parameters` contains the parameters selected.
 *          See ZDICT_trainFromBuffer() for details on failure modes.
 * Note: ZDICT_optimizeTrainFromBuffer_fastCover() requires about 6 * 2^f bytes of memory for each thread.
 */
ZDICTLIB_API size_t ZDICT_optimizeTrainFromBuffer_fastCover(void* dictBuffer,
                    size_t dictBufferCapacity, const void* samplesBuffer,
                    const size_t* samplesSizes, unsigned nbSamples,
                    ZDICT_fastCover_params_t* parameters);

/*! ZDICT_finalizeDictionary():
 * Given a custom content as a basis for dictionary, and a set of samples,
 * finalize dictionary by adding headers and statistics.
 *
 * Samples must be stored concatenated in a flat buffer `samplesBuffer`,
 * supplied with an array of sizes `samplesSizes`, providing the size of each sample in order.
 *
 * dictContentSize must be >= ZDICT_CONTENTSIZE_MIN bytes.
 * maxDictSize must be >= dictContentSize, and must be >= ZDICT_DICTSIZE_MIN bytes.
 *
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`),
 *          or an error code, which can be tested by ZDICT_isError().
 * Note: ZDICT_finalizeDictionary() will push notifications into stderr if instructed to, using notificationLevel>0.
 * Note 2: dictBuffer and dictContent can overlap
 */
#define ZDICT_CONTENTSIZE_MIN 128
#define ZDICT_DICTSIZE_MIN    256
ZDICTLIB_API size_t ZDICT_finalizeDictionary(void* dictBuffer, size_t dictBufferCapacity,
                                const void* dictContent, size_t dictContentSize,
                                const void* samplesBuffer, const size_t* samplesSizes, unsigned nbSamples,
                                ZDICT_params_t parameters);

typedef struct {
    unsigned selectivityLevel;   /* 0 means default; larger => select more => larger dictionary */
    ZDICT_params_t zParams;
} ZDICT_legacy_params_t;

/*! ZDICT_trainFromBuffer_legacy():
 *  Train a dictionary from an array of samples.
 *  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,
 *  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order.
 *  The resulting dictionary will be saved into `dictBuffer`.
 * `parameters` is optional and can be provided with values set to 0 to mean "default".
 * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
 *          or an error code, which can be tested with ZDICT_isError().
 *          See ZDICT_trainFromBuffer() for details on failure modes.
 *  Tips: In general, a reasonable dictionary has a size of ~ 100 KB.
 *        It's possible to select smaller or larger size, just by specifying `dictBufferCapacity`.
 *        In general, it's recommended to provide a few thousands samples, though this can vary a lot.
 *        It's recommended that total size of all samples be about ~x100 times the target size of dictionary.
 *  Note: ZDICT_trainFromBuffer_legacy() will send notifications into stderr if instructed to, using notificationLevel>0.
 */
ZDICTLIB_API size_t ZDICT_trainFromBuffer_legacy(
    void *dictBuffer, size_t dictBufferCapacity,
    const void *samplesBuffer, const size_t *samplesSizes, unsigned nbSamples,
    ZDICT_legacy_params_t parameters);

/* Deprecation warnings */
/* It is generally possible to disable deprecation warnings from compiler,
   for example with -Wno-deprecated-declarations for gcc
   or _CRT_SECURE_NO_WARNINGS in Visual.
   Otherwise, it's also possible to manually define ZDICT_DISABLE_DEPRECATE_WARNINGS */
#ifdef ZDICT_DISABLE_DEPRECATE_WARNINGS
#  define ZDICT_DEPRECATED(message) ZDICTLIB_API   /* disable deprecation warnings */
#else
#  define ZDICT_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
#  if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */
#    define ZDICT_DEPRECATED(message) [[deprecated(message)]] ZDICTLIB_API
#  elif (ZDICT_GCC_VERSION >= 405) || defined(__clang__)
#    define ZDICT_DEPRECATED(message) ZDICTLIB_API __attribute__((deprecated(message)))
#  elif (ZDICT_GCC_VERSION >= 301)
#    define ZDICT_DEPRECATED(message) ZDICTLIB_API __attribute__((deprecated))
#  elif defined(_MSC_VER)
#    define ZDICT_DEPRECATED(message) ZDICTLIB_API __declspec(deprecated(message))
#  else
#    pragma message("WARNING: You need to implement ZDICT_DEPRECATED for this compiler")
#    define ZDICT_DEPRECATED(message) ZDICTLIB_API
#  endif
#endif /* ZDICT_DISABLE_DEPRECATE_WARNINGS */

ZDICT_DEPRECATED("use ZDICT_finalizeDictionary() instead")
size_t ZDICT_addEntropyTablesFromBuffer(void* dictBuffer, size_t dictContentSize, size_t dictBufferCapacity,
                                  const void* samplesBuffer, const size_t* samplesSizes, unsigned nbSamples);

#endif   /* ZDICT_STATIC_LINKING_ONLY */

#if defined (__cplusplus)
}
#endif

#endif   /* DICTBUILDER_H_001 */

${this.title}

Code Editor : zdict.h