File Manager

X7ROOT File Manager

Current Path: /usr/include

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

Editing: 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 */

X7ROOT File Manager

Editing: zdict.h

Upload File

Create Folder