@thi.ng/binary 3.3.13 → 3.3.15

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-22T21:47:07Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -21,7 +21,7 @@ This project is part of the
 
 ## About
 
-100+ assorted binary / bitwise operations, conversions, utilities, lookup tables
+100+ assorted binary / bitwise operations, conversions, utilities, lookup tables.
 
 ## Status
 

package/count.d.ts

@@ -16,7 +16,7 @@ export declare const popCountArray: (data: IntArray | UIntArray, start?: number,
 /**
  * Returns number of bit changes between `x` and `y`.
  *
- * {@link https://en.wikipedia.org/wiki/Hamming_distance}
+ * https://en.wikipedia.org/wiki/Hamming_distance
  *
  * @param x -
  * @param y -
@@ -25,7 +25,7 @@ export declare const hammingDist: FnN2;
 /**
  * Math.clz32() polyfill (corrected).
  *
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/clz32$revision/1426816}
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/clz32$revision/1426816
  *
  * @param x -
  */

package/count.js

@@ -24,7 +24,7 @@ export const popCountArray = (data, start = 0, n = data.length) => {
 /**
  * Returns number of bit changes between `x` and `y`.
  *
- * {@link https://en.wikipedia.org/wiki/Hamming_distance}
+ * https://en.wikipedia.org/wiki/Hamming_distance
  *
  * @param x -
  * @param y -
@@ -33,7 +33,7 @@ export const hammingDist = (x, y) => popCount(x ^ y);
 /**
  * Math.clz32() polyfill (corrected).
  *
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/clz32$revision/1426816}
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/clz32$revision/1426816
  *
  * @param x -
  */

package/float.d.ts

@@ -36,11 +36,13 @@ export declare const intBitsToFloat64: FnN2;
  */
 export declare const uintBitsToFloat64: FnN2;
 /**
- * Converts given float (f32) into a sortable integer representation,
- * using raw bitwise conversion via {@link floatToIntBits}.
+ * Converts given float (f32) into a sortable integer representation, using raw
+ * bitwise conversion via {@link floatToIntBits}.
  *
- * {@link https://github.com/tzaeschke/phtree/blob/develop/PhTreeRevisited.pdf}
- * (page 3)
+ * @remarks
+ * References:
+ * - https://github.com/tzaeschke/phtree/blob/develop/PhTreeRevisited.pdf (page
+ *   3)
  *
  * @param x - value to convert
  */

package/float.js

@@ -45,11 +45,13 @@ export const uintBitsToFloat64 = (hi, lo) => {
     return F64[0];
 };
 /**
- * Converts given float (f32) into a sortable integer representation,
- * using raw bitwise conversion via {@link floatToIntBits}.
+ * Converts given float (f32) into a sortable integer representation, using raw
+ * bitwise conversion via {@link floatToIntBits}.
  *
- * {@link https://github.com/tzaeschke/phtree/blob/develop/PhTreeRevisited.pdf}
- * (page 3)
+ * @remarks
+ * References:
+ * - https://github.com/tzaeschke/phtree/blob/develop/PhTreeRevisited.pdf (page
+ *   3)
  *
  * @param x - value to convert
  */

package/gray.d.ts

@@ -1,10 +1,12 @@
 import type { FnN } from "@thi.ng/api";
 /**
- * Converts 32bit unsigned int to Gray code (reflected binary). Gray
- * codes of successive values always have a Hamming distance of 1 (i.e.
- * only 1 bit changes at a time).
+ * Converts 32bit unsigned int to Gray code (reflected binary). Gray codes of
+ * successive values always have a Hamming distance of 1 (i.e. only 1 bit
+ * changes at a time).
  *
- * {@link https://en.wikipedia.org/wiki/Gray_code}
+ * @remarks
+ * Reference:
+ * - https://en.wikipedia.org/wiki/Gray_code
  *
  * @param x - u32
  */
@@ -12,7 +14,9 @@ export declare const encodeGray32: FnN;
 /**
  * Converts 32bit Gray code to binary / unsigned int.
  *
- * {@link https://en.wikipedia.org/wiki/Gray_code}
+ * @remarks
+ * Reference:
+ * - https://en.wikipedia.org/wiki/Gray_code
  */
 export declare const decodeGray32: FnN;
 //# sourceMappingURL=gray.d.ts.map

package/gray.js

@@ -1,9 +1,11 @@
 /**
- * Converts 32bit unsigned int to Gray code (reflected binary). Gray
- * codes of successive values always have a Hamming distance of 1 (i.e.
- * only 1 bit changes at a time).
+ * Converts 32bit unsigned int to Gray code (reflected binary). Gray codes of
+ * successive values always have a Hamming distance of 1 (i.e. only 1 bit
+ * changes at a time).
  *
- * {@link https://en.wikipedia.org/wiki/Gray_code}
+ * @remarks
+ * Reference:
+ * - https://en.wikipedia.org/wiki/Gray_code
  *
  * @param x - u32
  */
@@ -11,7 +13,9 @@ export const encodeGray32 = (x) => (x ^ (x >>> 1)) >>> 0;
 /**
  * Converts 32bit Gray code to binary / unsigned int.
  *
- * {@link https://en.wikipedia.org/wiki/Gray_code}
+ * @remarks
+ * Reference:
+ * - https://en.wikipedia.org/wiki/Gray_code
  */
 export const decodeGray32 = (x) => {
     x = x ^ (x >>> 16);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/binary",
-  "version": "3.3.13",
+  "version": "3.3.15",
   "description": "100+ assorted binary / bitwise operations, conversions, utilities, lookup tables",
   "type": "module",
   "module": "./index.js",
@@ -34,11 +34,11 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0"
+    "@thi.ng/api": "^8.6.2"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/testament": "^0.3.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -129,5 +129,5 @@
       "transducers-binary"
     ]
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
 }