Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
xxhash-addon
Advanced tools
xxhash-addon - npm Package Compare versions
Comparing version 1.2.0 to 1.3.0
@@ -0,1 +1,6 @@ | ||
| ## v1.3.0 | ||
| ### Dependencies | ||
| - Upgrading `xxhash` to `v0.7.3` | ||
| ## v1.2.0 | ||
@@ -2,0 +7,0 @@ ### Features |
| xxHash - Extremely fast hash algorithm | ||
| ====================================== | ||
| <!-- TODO: Update. --> | ||
| xxHash is an Extremely fast Hash algorithm, running at RAM speed limits. | ||
| It successfully completes the [SMHasher](http://code.google.com/p/smhasher/wiki/SMHasher) test suite | ||
| It successfully completes the [SMHasher](https://code.google.com/p/smhasher/wiki/SMHasher) test suite | ||
| which evaluates collision, dispersion and randomness qualities of hash functions. | ||
@@ -23,17 +24,17 @@ Code is highly portable, and hashes are identical on all platforms (little / big endian). | ||
| | Name | Speed | Quality | Author | | ||
| |---------------|-------------|:-------:|-------------------| | ||
| | [xxHash] | 5.4 GB/s | 10 | Y.C. | | ||
| | MurmurHash 3a | 2.7 GB/s | 10 | Austin Appleby | | ||
| | SBox | 1.4 GB/s | 9 | Bret Mulvey | | ||
| | Lookup3 | 1.2 GB/s | 9 | Bob Jenkins | | ||
| | CityHash64 | 1.05 GB/s | 10 | Pike & Alakuijala | | ||
| | FNV | 0.55 GB/s | 5 | Fowler, Noll, Vo | | ||
| | CRC32 | 0.43 GB/s † | 9 | | | ||
| | MD5-32 | 0.33 GB/s | 10 | Ronald L.Rivest | | ||
| | SHA1-32 | 0.28 GB/s | 10 | | | ||
| | Name | Speed | Quality | Author | | ||
| |---------------|--------------------|:-------:|-------------------| | ||
| | [xxHash] | 5.4 GB/s | 10 | Y.C. | | ||
| | MurmurHash 3a | 2.7 GB/s | 10 | Austin Appleby | | ||
| | SBox | 1.4 GB/s | 9 | Bret Mulvey | | ||
| | Lookup3 | 1.2 GB/s | 9 | Bob Jenkins | | ||
| | CityHash64 | 1.05 GB/s | 10 | Pike & Alakuijala | | ||
| | FNV | 0.55 GB/s | 5 | Fowler, Noll, Vo | | ||
| | CRC32 | 0.43 GB/s † | 9 | | | ||
| | MD5-32 | 0.33 GB/s | 10 | Ronald L.Rivest | | ||
| | SHA1-32 | 0.28 GB/s | 10 | | | ||
| [xxHash]: http://www.xxhash.com | ||
| [xxHash]: https://www.xxhash.com | ||
| Note †: SMHasher's CRC32 implementation is known to be slow. Faster implementations exist. | ||
| Note †: SMHasher's CRC32 implementation is known to be slow. Faster implementations exist. | ||
@@ -52,3 +53,3 @@ Q.Score is a measure of quality of the hash function. | ||
| | Version | Speed on 64-bit | Speed on 32-bit | | ||
| | Version | Speed on 64-bit | Speed on 32-bit | | ||
| |------------|------------------|------------------| | ||
@@ -58,4 +59,4 @@ | XXH64 | 13.8 GB/s | 1.9 GB/s | | ||
| This project also includes a command line utility, named `xxhsum`, offering similar features as `md5sum`, | ||
| thanks to [Takayuki Matsuoka](https://github.com/t-mat) contributions. | ||
| This project also includes a command line utility, named `xxhsum`, offering similar features to `md5sum`, | ||
| thanks to [Takayuki Matsuoka](https://github.com/t-mat)'s contributions. | ||
@@ -69,41 +70,75 @@ | ||
| ### New hash algorithms | ||
| Starting with `v0.7.0`, the library includes a new algorithm named `XXH3`, | ||
| which is able to generate 64 and 128-bit hashes. | ||
| The new algorithm is much faster than its predecessors for both long and small inputs, | ||
| which can be observed in the following graphs: | ||
|  | ||
|  | ||
| To access these new prototypes, one needs to unlock their declaration, using the build macro `XXH_STATIC_LINKING_ONLY`. | ||
| The algorithm is currently in development, meaning its return values might still change in future versions. | ||
| However, the API is stable, and can be used in production, typically for ephemeral | ||
| data (produced and consumed in same session). | ||
| `XXH3`'s return values will be finalized upon reaching `v0.8.0`. | ||
| ### Build modifiers | ||
| The following macros can be set at compilation time, | ||
| they modify libxxhash behavior. They are all disabled by default. | ||
| The following macros can be set at compilation time to modify libxxhash's behavior. They are all disabled by default. | ||
| - `XXH_INLINE_ALL` : Make all functions `inline`, with bodies directly included within `xxhash.h`. | ||
| Inlining functions is beneficial for speed on small keys. | ||
| It's _extremely effective_ when key length is expressed as _a compile time constant_, | ||
| with performance improvements observed in the +200% range . | ||
| See [this article](https://fastcompression.blogspot.com/2018/03/xxhash-for-small-keys-impressive-power.html) for details. | ||
| Note: there is no need for an `xxhash.o` object file in this case. | ||
| - `XXH_REROLL` : reduce size of generated code. Impact on performance vary, depending on platform and algorithm. | ||
| - `XXH_ACCEPT_NULL_INPUT_POINTER` : if set to `1`, when input is a `NULL` pointer, | ||
| xxhash result is the same as a zero-length input | ||
| (instead of a dereference segfault). | ||
| Adds one branch at the beginning of the hash. | ||
| - `XXH_FORCE_MEMORY_ACCESS` : default method `0` uses a portable `memcpy()` notation. | ||
| Method `1` uses a gcc-specific `packed` attribute, which can provide better performance for some targets. | ||
| Method `2` forces unaligned reads, which is not standard compliant, but might sometimes be the only way to extract better read performance. | ||
| - `XXH_CPU_LITTLE_ENDIAN` : by default, endianess is determined at compile time. | ||
| It's possible to skip auto-detection and force format to little-endian, by setting this macro to 1. | ||
| - `XXH_INLINE_ALL`: Make all functions `inline`, with implementations being directly included within `xxhash.h`. | ||
| Inlining functions is beneficial for speed on small keys. | ||
| It's _extremely effective_ when key length is expressed as _a compile time constant_, | ||
| with performance improvements being observed in the +200% range . | ||
| See [this article](https://fastcompression.blogspot.com/2018/03/xxhash-for-small-keys-impressive-power.html) for details. | ||
| Note: there is no need to compile an `xxhash.o` object file in this case. | ||
| - `XXH_NO_INLINE_HINTS`: By default, xxHash uses tricks like `__attribute__((always_inline))` and `__forceinline` to try and improve performance at the cost of code size. Defining this to 1 will mark all internal functions as `static`, allowing the compiler to decide whether to inline a function or not. This is very useful when optimizing for the smallest binary size, and it is automatically defined when compiling with `-O0`, `-Os`, `-Oz`, or `-fno-inline` on GCC and Clang. This may also increase performance depending on the compiler and the architecture. | ||
| - `XXH_REROLL`: Reduces the size of the generated code by not unrolling some loops. Impact on performance may vary, depending on the platform and the algorithm. | ||
| - `XXH_ACCEPT_NULL_INPUT_POINTER`: if set to `1`, when input is a `NULL` pointer, | ||
| xxHash'd result is the same as a zero-length input | ||
| (instead of a dereference segfault). | ||
| Adds one branch at the beginning of the hash. | ||
| - `XXH_FORCE_MEMORY_ACCESS`: The default method `0` uses a portable `memcpy()` notation. | ||
| Method `1` uses a gcc-specific `packed` attribute, which can provide better performance for some targets. | ||
| Method `2` forces unaligned reads, which is not standards compliant, but might sometimes be the only way to extract better read performance. | ||
| Method `3` uses a byteshift operation, which is best for old compilers which don't inline `memcpy()` or big-endian systems without a byteswap instruction | ||
| - `XXH_CPU_LITTLE_ENDIAN`: By default, endianess is determined at compile time. | ||
| It's possible to skip auto-detection and force format to little-endian, by setting this macro to 1. | ||
| Setting it to 0 forces big-endian. | ||
| - `XXH_PRIVATE_API` : same impact as `XXH_INLINE_ALL`. | ||
| Name underlines that XXH_* symbols will not be published. | ||
| - `XXH_NAMESPACE` : prefix all symbols with the value of `XXH_NAMESPACE`. | ||
| - `XXH_PRIVATE_API`: same impact as `XXH_INLINE_ALL`. | ||
| Name underlines that XXH_* symbols will not be exported. | ||
| - `XXH_NAMESPACE`: Prefixes all symbols with the value of `XXH_NAMESPACE`. | ||
| Useful to evade symbol naming collisions, | ||
| in case of multiple inclusions of xxHash source code. | ||
| Client applications can still use regular function name, | ||
| symbols are automatically translated through `xxhash.h`. | ||
| - `XXH_STATIC_LINKING_ONLY` : gives access to state declaration for static allocation. | ||
| Incompatible with dynamic linking, due to risks of ABI changes. | ||
| - `XXH_NO_LONG_LONG` : removes support for XXH64, | ||
| for targets without 64-bit support. | ||
| - `XXH_IMPORT` : MSVC specific : should only be defined for dynamic linking, it prevents linkage errors. | ||
| in case of multiple inclusions of xxHash's source code. | ||
| Client applications can still use the regular function name, | ||
| as symbols are automatically translated through `xxhash.h`. | ||
| - `XXH_STATIC_LINKING_ONLY`: gives access to the state declaration for static allocation. | ||
| Incompatible with dynamic linking, due to risks of ABI changes. | ||
| - `XXH_NO_LONG_LONG`: removes support for XXH3 and XXH64 for targets without 64-bit support. | ||
| - `XXH_IMPORT`: MSVC specific: should only be defined for dynamic linking, as it prevents linkage errors. | ||
| ### Building xxHash - Using vcpkg | ||
| You can download and install xxHash using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager: | ||
| git clone https://github.com/Microsoft/vcpkg.git | ||
| cd vcpkg | ||
| ./bootstrap-vcpkg.sh | ||
| ./vcpkg integrate install | ||
| ./vcpkg install xxhash | ||
| The xxHash port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository. | ||
| ### Example | ||
| Calling xxhash 64-bit variant from a C program : | ||
| Calling xxhash 64-bit variant from a C program: | ||
@@ -118,3 +153,3 @@ ```C | ||
| Using streaming variant is more involved, but makes it possible to provide data incrementally : | ||
| Using streaming variant is more involved, but makes it possible to provide data incrementally: | ||
| ```C | ||
@@ -159,29 +194,9 @@ #include "stdlib.h" /* abort() */ | ||
| ### New experimental hash algorithm | ||
| Starting with `v0.7.0`, the library includes a new algorithm, named `XXH3`, | ||
| able to generate 64 and 128-bits hashes. | ||
| The new algorithm is much faster than its predecessors, | ||
| for both long and small inputs, | ||
| as can be observed in following graphs : | ||
|  | ||
|  | ||
| The algorithm is currently labeled experimental, its return values can still change in future versions. | ||
| It can already be used for ephemeral data, and for tests, but avoid storing long-term hash values yet. | ||
| To access experimental prototypes, one need to unlock their declaration using macro `XXH_STATIC_LINKING_ONLY`. | ||
| `XXH3` will be stabilized in a future version. | ||
| This period is used to collect users' feedback. | ||
| ### Other programming languages | ||
| Beyond the C reference version, | ||
| xxHash is also available on many programming languages, | ||
| thanks to great contributors. | ||
| They are [listed here](http://www.xxhash.com/#other-languages). | ||
| Aside from the C reference version, | ||
| xxHash is also available in many different programming languages, | ||
| thanks to many great contributors. | ||
| They are [listed here](https://www.xxhash.com/#other-languages). | ||
@@ -188,0 +203,0 @@ |
| { | ||
| "name": "xxhash-addon", | ||
| "version": "1.2.0", | ||
| "version": "1.3.0", | ||
| "description": "Yet another xxhash addon for Node.js", | ||
@@ -8,2 +8,3 @@ "main": "xxhash-addon.js", | ||
| "install": "node-gyp rebuild --ensure", | ||
| "ci:install": "node-gyp rebuild --verbose --ensure", | ||
| "test": "jest" | ||
@@ -13,3 +14,2 @@ }, | ||
| "/deps/xxHash/xxhash.h", | ||
| "/deps/xxHash/xxhash.c", | ||
| "/deps/xxHash/xxh3.h", | ||
@@ -39,3 +39,3 @@ "/deps/xxHash/LICENSE", | ||
| "devDependencies": { | ||
| "jest": "^24.9.0" | ||
| "jest": "^25.3.0" | ||
| }, | ||
@@ -42,0 +42,0 @@ "engines": { |
@@ -10,11 +10,12 @@ Yet another xxhash addon for Node.js | ||
| |Debian | [](https://circleci.com/gh/ktrongnhan/xxhash-addon) | | ||
| |OSX | [](https://travis-ci.org/ktrongnhan/xxhash-addon) | | ||
| Overview | ||
| =========== | ||
| `xxhash-addon` is a native addon for Node.js (>=8.6.0) written using N-API. It 'thinly' wraps [xxhash](https://github.com/Cyan4973/xxHash) version 0.7.2, which has support for a new algorithm `XXH3` that has showed to outperform its predecessor. | ||
| `xxhash-addon` is a native addon for Node.js (>=8.6.0) written using N-API. It 'thinly' wraps [xxhash](https://github.com/Cyan4973/xxHash) version 0.7.3, which has support for a new algorithm `XXH3` that has showed to outperform its predecessor. | ||
| Features | ||
| ========== | ||
| * `xxhash-addon` exposes xxhash's API in a friendly way for downstream consumption(see the Example of Usage section). | ||
| * Covering all 4 variants of the algorithm: XXH32, XXH64, XXH3 64-bit, XXH3 128-bit (for experimental use only). | ||
| * `xxhash-addon` exposes xxhash's API in a friendly way for downstream consumption (see the Example of Usage section). | ||
| * Covering all 4 variants of the algorithm: XXH32, XXH64, XXH3 64-bit, XXH3 128-bit (XXH3 is for experimental use only). | ||
| * Supporting XXH3 secret. | ||
@@ -31,3 +32,3 @@ * Consistently producing canonical (big-endian) form of hash values as per [xxhash's recommendation](https://github.com/Cyan4973/xxHash/blob/e2f4695899e831171ecd2e780078474712ea61d3/xxhash.h#L243). | ||
| Note: This native addon requires recompiling. If you do not have Node.js building toolchain installed then you must install them first | ||
| Note: This native addon requires recompiling. If you do not have Node.js building toolchain installed then you must install them first: | ||
@@ -50,2 +51,6 @@ * On a Windows machine | ||
| * On a Mac | ||
| Install `Xcode command line tools` | ||
| In comparison to other implementations/bindings | ||
@@ -52,0 +57,0 @@ ========= |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by14.56%
216790
- Number of package files
- increased by5%
21
- Number of lines in readme file
- increased by3.82%
136
No dependency changes