@thi.ng/binary 3.1.3 → 3.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [3.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/binary@3.2.0) (2022-03-11)
+
+#### 🚀 Features
+
+- add shiftRL() ([804565e](https://github.com/thi-ng/umbrella/commit/804565e))
+
 ## [3.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/binary@3.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -56,7 +56,7 @@ node --experimental-repl-await
 > const binary = await import("@thi.ng/binary");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 2.17 KB
+Package sizes (gzipped, pre-treeshake): ESM: 2.19 KB
 
 ## Dependencies
 
@@ -97,4 +97,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2016 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2016 - 2022 Karsten Schmidt // Apache Software License 2.0

package/float.d.ts

@@ -11,28 +11,28 @@ export declare const uintBitsToFloat: FnN;
  * Returns i32 representation of f64 as [hi, lo] tuple (takes
  * environment's Little Endianess into account).
  *
- * @param x
+ * @param x -
  */
 export declare const floatToIntBits64: (x: number) => [number, number];
 /**
  * Returns u32 representation of f64 as [hi, lo] tuple (takes
  * environment's Little Endianess into account).
  *
- * @param x
+ * @param x -
  */
 export declare const floatToUintBits64: (x: number) => [number, number];
 /**
  * Reverse op of {@link floatToIntBits64}.
  *
- * @param hi
- * @param lo
+ * @param hi -
+ * @param lo -
  */
 export declare const intBitsToFloat64: FnN2;
 /**
  * Reverse op of {@link floatToUintBits64}.
  *
- * @param hi
- * @param lo
+ * @param hi -
+ * @param lo -
  */
 export declare const uintBitsToFloat64: FnN2;
 /**
@@ -48,49 +48,49 @@ export declare const floatToSortableInt: FnN;
 /**
  * Converts normalized float ([-1..1] range) to u8.
  *
- * @param x
+ * @param x -
  */
 export declare const f32u8: FnN;
 /**
  * Converts normalized float ([-1..1] range) to u16.
  *
- * @param x
+ * @param x -
  */
 export declare const f32u16: FnN;
 /**
  * Converts normalized float ([-1..1] range) to u24.
  *
- * @param x
+ * @param x -
  */
 export declare const f32u24: FnN;
 /**
  * Converts normalized float ([-1..1] range) to u32.
  *
- * @param x
+ * @param x -
  */
 export declare const f32u32: FnN;
 /**
  * Reverse op of {@link f32u8}.
  *
- * @param x
+ * @param x -
  */
 export declare const u8f32: FnN;
 /**
  * Reverse op of {@link f32u16}.
  *
- * @param x
+ * @param x -
  */
 export declare const u16f32: FnN;
 /**
  * Reverse op of {@link f32u24}.
  *
- * @param x
+ * @param x -
  */
 export declare const u24f32: FnN;
 /**
  * Reverse op of {@link f32u32}.
  *
- * @param x
+ * @param x -
  */
 export declare const u32f32: FnN;
 //# sourceMappingURL=float.d.ts.map

package/float.js

@@ -14,21 +14,21 @@ export const uintBitsToFloat = (x) => ((U32[0] = x), F32[0]);
  * Returns i32 representation of f64 as [hi, lo] tuple (takes
  * environment's Little Endianess into account).
  *
- * @param x
+ * @param x -
  */
 export const floatToIntBits64 = (x) => ((F64[0] = x), IS_LE ? [I32[1], I32[0]] : [I32[0], I32[1]]);
 /**
  * Returns u32 representation of f64 as [hi, lo] tuple (takes
  * environment's Little Endianess into account).
  *
- * @param x
+ * @param x -
  */
 export const floatToUintBits64 = (x) => ((F64[0] = x), IS_LE ? [U32[1], U32[0]] : [U32[0], U32[1]]);
 /**
  * Reverse op of {@link floatToIntBits64}.
  *
- * @param hi
- * @param lo
+ * @param hi -
+ * @param lo -
  */
 export const intBitsToFloat64 = (hi, lo) => {
     IS_LE ? ((I32[1] = hi), (I32[0] = lo)) : ((I32[0] = hi), (I32[1] = lo));
@@ -37,8 +37,8 @@ export const intBitsToFloat64 = (hi, lo) => {
 /**
  * Reverse op of {@link floatToUintBits64}.
  *
- * @param hi
- * @param lo
+ * @param hi -
+ * @param lo -
  */
 export const uintBitsToFloat64 = (hi, lo) => {
     IS_LE ? ((U32[1] = hi), (U32[0] = lo)) : ((U32[0] = hi), (U32[1] = lo));
@@ -63,48 +63,48 @@ const clamp11 = (x) => (x < -1 ? -1 : x > 1 ? 1 : x);
 /**
  * Converts normalized float ([-1..1] range) to u8.
  *
- * @param x
+ * @param x -
  */
 export const f32u8 = (x) => (clamp11(x) * 0x7f) & 0xff;
 /**
  * Converts normalized float ([-1..1] range) to u16.
  *
- * @param x
+ * @param x -
  */
 export const f32u16 = (x) => (clamp11(x) * 0x7fff) & 0xffff;
 /**
  * Converts normalized float ([-1..1] range) to u24.
  *
- * @param x
+ * @param x -
  */
 export const f32u24 = (x) => (clamp11(x) * 0x7fffff) & 0xffffff;
 /**
  * Converts normalized float ([-1..1] range) to u32.
  *
- * @param x
+ * @param x -
  */
 export const f32u32 = (x) => (clamp11(x) * 0x7fffffff) >>> 0;
 /**
  * Reverse op of {@link f32u8}.
  *
- * @param x
+ * @param x -
  */
 export const u8f32 = (x) => ((x &= 0xff), (x | ((x >> 7) * 0xffffff00)) / 0x7f);
 /**
  * Reverse op of {@link f32u16}.
  *
- * @param x
+ * @param x -
  */
 export const u16f32 = (x) => ((x &= 0xffff), (x | ((x >> 15) * 0xffff0000)) / 0x7fff);
 /**
  * Reverse op of {@link f32u24}.
  *
- * @param x
+ * @param x -
  */
 export const u24f32 = (x) => ((x &= 0xffffff), (x | ((x >> 23) * 0xff000000)) / 0x7fffff);
 /**
  * Reverse op of {@link f32u32}.
  *
- * @param x
+ * @param x -
  */
 export const u32f32 = (x) => (x | 0) / 0x7fffffff;

package/one-hot.d.ts

@@ -5,7 +5,7 @@ import type { Range0_31 } from "@thi.ng/api";
  * @remarks
  * Reference: https://en.wikipedia.org/wiki/One-hot
  *
- * @param x
+ * @param x -
  */
 export declare const binaryOneHot: (x: Range0_31) => number;
 /**
@@ -14,7 +14,7 @@ export declare const binaryOneHot: (x: Range0_31) => number;
  * @remarks
  * Reference: https://en.wikipedia.org/wiki/One-hot
  *
- * @param x
+ * @param x -
  */
 export declare const oneHotBinary: (x: number) => number;
 //# sourceMappingURL=one-hot.d.ts.map

package/one-hot.js

@@ -5,7 +5,7 @@ import { clz32 } from "./count.js";
  * @remarks
  * Reference: https://en.wikipedia.org/wiki/One-hot
  *
- * @param x
+ * @param x -
  */
 export const binaryOneHot = (x) => (1 << x) >>> 0;
 /**
@@ -14,6 +14,6 @@ export const binaryOneHot = (x) => (1 << x) >>> 0;
  * @remarks
  * Reference: https://en.wikipedia.org/wiki/One-hot
  *
- * @param x
+ * @param x -
  */
 export const oneHotBinary = (x) => 31 - clz32(x);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/binary",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "100+ assorted binary / bitwise operations, conversions, utilities, lookup tables",
   "type": "module",
   "module": "./index.js",
@@ -34,15 +34,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3"
+    "@thi.ng/api": "^8.3.4"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "align",
@@ -129,5 +129,5 @@
       "transducers-binary"
     ]
   },
-  "gitHead": "2db9dd34c0c2c60cbfde3dad0bca352b20292f5c\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/rotate.d.ts

@@ -13,4 +13,12 @@ export declare const rotateLeft: (x: number, n: Bit) => number;
  * @param n - rotation step
  */
 export declare const rotateRight: (x: number, n: Bit) => number;
+/**
+ * Shifts `x` by `n` bits left or right. If `n` >= 0, the value will be `>>>`
+ * shifted to right, if `n` < 0 the value will be shifted left.
+ *
+ * @param x -
+ * @param n -
+ */
+export declare const shiftRL: (x: number, n: number) => number;
 //# sourceMappingURL=rotate.d.ts.map

package/rotate.js

@@ -12,3 +12,11 @@ export const rotateLeft = (x, n) => ((x << n) | (x >>> (32 - n))) >>> 0;
  * @param n - rotation step
  */
 export const rotateRight = (x, n) => ((x >>> n) | (x << (32 - n))) >>> 0;
+/**
+ * Shifts `x` by `n` bits left or right. If `n` >= 0, the value will be `>>>`
+ * shifted to right, if `n` < 0 the value will be shifted left.
+ *
+ * @param x -
+ * @param n -
+ */
+export const shiftRL = (x, n) => (n < 0 ? x << -n : x >>> n);

package/splat.d.ts

@@ -44,13 +44,13 @@ export declare const same8: (x: number) => boolean;
 /**
  * Expands 3x4bit value like `0xabc` to 24bits: `0xaabbcc`
  *
- * @param x
+ * @param x -
  */
 export declare const interleave4_12_24: (x: number) => number;
 /**
  * Expands 4x4bit value like `0xabcd` to 32bits: `0xaabbccdd`
  *
- * @param x
+ * @param x -
  */
 export declare const interleave4_16_32: (x: number) => number;
 //# sourceMappingURL=splat.d.ts.map

package/splat.js

@@ -43,13 +43,13 @@ export const same8 = (x) => ((x >> 8) & 0xff) === (x & 0xff);
 /**
  * Expands 3x4bit value like `0xabc` to 24bits: `0xaabbcc`
  *
- * @param x
+ * @param x -
  */
 export const interleave4_12_24 = (x) => ((x & 0xf00) * 0x1100) | ((x & 0xf0) * 0x110) | ((x & 0xf) * 0x11);
 /**
  * Expands 4x4bit value like `0xabcd` to 32bits: `0xaabbccdd`
  *
- * @param x
+ * @param x -
  */
 export const interleave4_16_32 = (x) => (((x & 0xf000) * 0x11000) |
     ((x & 0xf00) * 0x1100) |

package/swizzle.d.ts

@@ -116,9 +116,9 @@ export declare const swizzle4: (x: number, a: Lane4, b: Lane4, c: Lane4, d: Lane
  * // 0x12345555
  * ```
  *
- * @param a
- * @param b
- * @param mask
+ * @param a -
+ * @param b -
+ * @param mask -
  */
 export declare const mux: FnN3;
 /**
@@ -136,7 +136,7 @@ export declare const flip8: FnN;
  * // 0x56781234
  * ```
  *
- * @param x
+ * @param x -
  */
 export declare const flip16: FnN;
 /**
@@ -146,13 +146,13 @@ export declare const flipBytes: FnN;
 /**
  * Swaps bytes lanes 0 & 2 (i.e. bits 24-31 with bits 8-15)
  *
- * @param x
+ * @param x -
  */
 export declare const swapLane02: FnN;
 /**
  * Swaps bytes lanes 1 & 3 (i.e. bits 16-23 with bits 0-7)
  *
- * @param x
+ * @param x -
  */
 export declare const swapLane13: FnN;
 //# sourceMappingURL=swizzle.d.ts.map

package/swizzle.js

@@ -135,9 +135,9 @@ export const swizzle4 = (x, a, b, c, d, e, f, g, h) => ((lane4(x, a) << 28) |
  * // 0x12345555
  * ```
  *
- * @param a
- * @param b
- * @param mask
+ * @param a -
+ * @param b -
+ * @param mask -
  */
 export const mux = (a, b, mask) => (~mask & a) | (mask & b);
 /**
@@ -155,7 +155,7 @@ export const flip8 = (x) => ((x >>> 24) | ((x >> 8) & 0xff00) | ((x & 0xff00) <<
  * // 0x56781234
  * ```
  *
- * @param x
+ * @param x -
  */
 export const flip16 = (x) => mux(x << 16, x >>> 16, 0xffff);
 /**
@@ -165,12 +165,12 @@ export const flipBytes = flip8;
 /**
  * Swaps bytes lanes 0 & 2 (i.e. bits 24-31 with bits 8-15)
  *
- * @param x
+ * @param x -
  */
 export const swapLane02 = (x) => ((x & 0xff00) << 16) | ((x >>> 16) & 0xff00) | (x & 0x00ff00ff);
 /**
  * Swaps bytes lanes 1 & 3 (i.e. bits 16-23 with bits 0-7)
  *
- * @param x
+ * @param x -
  */
 export const swapLane13 = (x) => ((x & 0xff) << 16) | ((x >> 16) & 0xff) | (x & 0xff00ff00);