@thi.ng/adjacency 2.2.18 → 2.2.20

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-30T22:27:37Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![adjacency](https://media.thi.ng/umbrella/banners-20220914/thing-adjacency.svg?f522aab9)
+# ![@thi.ng/adjacency](https://media.thi.ng/umbrella/banners-20220914/thing-adjacency.svg?f522aab9)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/adjacency.svg)](https://www.npmjs.com/package/@thi.ng/adjacency)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/adjacency.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -21,7 +21,7 @@ This project is part of the
 
 ## About
 
-Sparse & bitwise adjacency matrices and related functions for directed & undirected graphs.
+Sparse & bitwise adjacency matrices and related functions for directed & undirected graphs
 
 ## Status
 
@@ -49,11 +49,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const adjacency = await import("@thi.ng/adjacency");
+```js
+const adjacency = await import("@thi.ng/adjacency");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 2.28 KB
@@ -87,7 +84,7 @@ TODO
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -102,4 +99,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2018 - 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2022 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -1,5 +1,5 @@
 import type { Fn2, Pair } from "@thi.ng/api";
-export declare type DegreeType = "in" | "out" | "inout";
+export type DegreeType = "in" | "out" | "inout";
 /**
  * @typeParam T - vertex type (default: `number`)
  */
@@ -63,6 +63,6 @@ export interface IGraph<T = number> {
      */
     invert(): IGraph<T>;
 }
-export declare type Edge<T = number> = Pair<T, T>;
-export declare type CostFn<T = number> = Fn2<T, T, number>;
+export type Edge<T = number> = Pair<T, T>;
+export type CostFn<T = number> = Fn2<T, T, number>;
 //# sourceMappingURL=api.d.ts.map

package/binary.d.ts

@@ -30,10 +30,11 @@ export declare class AdjacencyBitMatrix implements IGraph<number> {
     toDot(ids?: string[]): string;
 }
 /**
- * Creates adjacency matrix backed by a {@link @thi.ng/bitfield#BitMatrix}
+ * Creates adjacency matrix backed by a
+ * [`BitMatrix`](https://docs.thi.ng/umbrella/bitfield/classes/BitMatrix.html)
  * with capacity `n` (max vertices), optionally initialized with given edge
- * pairs. Each edge is `[src-node dest-node]`. If `undirected` is true
- * (default: false), creates symmetrical adjacencies.
+ * pairs. Each edge is `[src-node dest-node]`. If `undirected` is true (default:
+ * false), creates symmetrical adjacencies.
  *
  * @param n - max vertices
  * @param edges - edge pairs

package/binary.js

@@ -90,10 +90,11 @@ export class AdjacencyBitMatrix {
     }
 }
 /**
- * Creates adjacency matrix backed by a {@link @thi.ng/bitfield#BitMatrix}
+ * Creates adjacency matrix backed by a
+ * [`BitMatrix`](https://docs.thi.ng/umbrella/bitfield/classes/BitMatrix.html)
  * with capacity `n` (max vertices), optionally initialized with given edge
- * pairs. Each edge is `[src-node dest-node]`. If `undirected` is true
- * (default: false), creates symmetrical adjacencies.
+ * pairs. Each edge is `[src-node dest-node]`. If `undirected` is true (default:
+ * false), creates symmetrical adjacencies.
  *
  * @param n - max vertices
  * @param edges - edge pairs

package/disjoint-set.d.ts

@@ -1,10 +1,10 @@
 /**
- * Typed array based Disjoint Set implementation with quick union and
- * path compression, after Sedgewick & Wayne.
+ * Typed array based Disjoint Set implementation with quick union and path
+ * compression, after Sedgewick & Wayne.
  *
  * @remarks
- * - {@link https://en.wikipedia.org/wiki/Disjoint-set_data_structure}
- * - {@link https://algs4.cs.princeton.edu/lectures/15UnionFind-2x2.pdf}
+ * - https://en.wikipedia.org/wiki/Disjoint-set_data_structure
+ * - https://algs4.cs.princeton.edu/lectures/15UnionFind-2x2.pdf
  */
 export declare class DisjointSet {
     roots: Uint32Array;

package/disjoint-set.js

@@ -1,11 +1,11 @@
 import { fillRange } from "@thi.ng/arrays/fill-range";
 /**
- * Typed array based Disjoint Set implementation with quick union and
- * path compression, after Sedgewick & Wayne.
+ * Typed array based Disjoint Set implementation with quick union and path
+ * compression, after Sedgewick & Wayne.
  *
  * @remarks
- * - {@link https://en.wikipedia.org/wiki/Disjoint-set_data_structure}
- * - {@link https://algs4.cs.princeton.edu/lectures/15UnionFind-2x2.pdf}
+ * - https://en.wikipedia.org/wiki/Disjoint-set_data_structure
+ * - https://algs4.cs.princeton.edu/lectures/15UnionFind-2x2.pdf
  */
 export class DisjointSet {
     /**

package/mst.d.ts

@@ -15,9 +15,11 @@ import type { Fn } from "@thi.ng/api";
  * criteria. The result edges will be in ascending order, based on the supplied
  * cost function. The cost function is called once for each edge and return
  * values will be cached prior to sorting (see
- * {@link @thi.ng/arrays#sortByCachedKey} for details).
+ * [`sortByCachedKey()`](https://docs.thi.ng/umbrella/arrays/functions/sortByCachedKey.html)
+ * for details).
  *
- * Reference: {@link https://en.wikipedia.org/wiki/Kruskal%27s_algorithm}
+ * References:
+ * - https://en.wikipedia.org/wiki/Kruskal%27s_algorithm
  *
  * @example
  * ```ts

package/mst.js

@@ -16,9 +16,11 @@ import { DisjointSet } from "./disjoint-set.js";
  * criteria. The result edges will be in ascending order, based on the supplied
  * cost function. The cost function is called once for each edge and return
  * values will be cached prior to sorting (see
- * {@link @thi.ng/arrays#sortByCachedKey} for details).
+ * [`sortByCachedKey()`](https://docs.thi.ng/umbrella/arrays/functions/sortByCachedKey.html)
+ * for details).
  *
- * Reference: {@link https://en.wikipedia.org/wiki/Kruskal%27s_algorithm}
+ * References:
+ * - https://en.wikipedia.org/wiki/Kruskal%27s_algorithm
  *
  * @example
  * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/adjacency",
-  "version": "2.2.18",
+  "version": "2.2.20",
   "description": "Sparse & bitwise adjacency matrices and related functions for directed & undirected graphs",
   "type": "module",
   "module": "./index.js",
@@ -21,7 +21,7 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,21 +34,21 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/arrays": "^2.4.4",
-    "@thi.ng/bitfield": "^2.2.14",
-    "@thi.ng/dcons": "^3.2.25",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/sparse": "^0.3.30"
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/arrays": "^2.4.6",
+    "@thi.ng/bitfield": "^2.2.16",
+    "@thi.ng/dcons": "^3.2.27",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/sparse": "^0.3.32"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
-    "@thi.ng/vectors": "^7.5.26",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/vectors": "^7.5.28",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "adjacency",
@@ -119,5 +119,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/sparse.d.ts

@@ -13,7 +13,8 @@ export declare class AdjacencyMatrix extends CSR implements IGraph<number> {
     neighbors(id: number): number[];
     invert(): AdjacencyMatrix;
     /**
-     * Returns a diagonal sparse matrix {@link @thi.ng/sparse#CSR} containing
+     * Returns a diagonal sparse matrix
+     * [`CSR`](https://docs.thi.ng/umbrella/sparse/classes/CSR.html) containing
      * information about the degree of each vertex, i.e. the number of edges
      * attached to each vertex.
      *
@@ -24,12 +25,13 @@ export declare class AdjacencyMatrix extends CSR implements IGraph<number> {
      */
     degreeMat(deg?: DegreeType): CSR;
     /**
-     * Returns this graph's Laplacian matrix: `L = D - A` Where `D` is
-     * the degree matrix and `A` this adjacency matrix.
+     * Returns this graph's Laplacian matrix: `L = D - A` Where `D` is the
+     * degree matrix and `A` this adjacency matrix.
      *
      * @remarks
-     * - {@link https://en.wikipedia.org/wiki/Laplacian_matrix}
-     * - {@link https://en.wikipedia.org/wiki/Discrete_Laplace_operator}
+     * References:
+     * - https://en.wikipedia.org/wiki/Laplacian_matrix
+     * - https://en.wikipedia.org/wiki/Discrete_Laplace_operator
      *
      * @param deg - degree type for {@link AdjacencyMatrix.degreeMat}
      */
@@ -50,10 +52,11 @@ export declare class AdjacencyMatrix extends CSR implements IGraph<number> {
     toDot(ids?: string[]): string;
 }
 /**
- * Creates an adjacency matrix backed by a sparse {@link @thi.ng/sparse#CSR}
- * matrix, optionally initialize with given edge pairs. Each edge is a `[src,
- * dest]` tuple. If `undirected` is true (default: false), creates symmetrical
- * edges (i.e. undirected graph).
+ * Creates an adjacency matrix backed by a sparse
+ * [`CSR`](https://docs.thi.ng/umbrella/sparse/classes/CSR.html) matrix,
+ * optionally initialize with given edge pairs. Each edge is a `[src, dest]`
+ * tuple. If `undirected` is true (default: false), creates symmetrical edges
+ * (i.e. undirected graph).
  *
  * @param n - max number of vertices
  * @param edges - edge pairs

package/sparse.js

@@ -61,7 +61,8 @@ export class AdjacencyMatrix extends CSR {
         return __invert(defAdjMatrix(this.m, undefined, this.undirected), this.edges());
     }
     /**
-     * Returns a diagonal sparse matrix {@link @thi.ng/sparse#CSR} containing
+     * Returns a diagonal sparse matrix
+     * [`CSR`](https://docs.thi.ng/umbrella/sparse/classes/CSR.html) containing
      * information about the degree of each vertex, i.e. the number of edges
      * attached to each vertex.
      *
@@ -93,12 +94,13 @@ export class AdjacencyMatrix extends CSR {
         return res;
     }
     /**
-     * Returns this graph's Laplacian matrix: `L = D - A` Where `D` is
-     * the degree matrix and `A` this adjacency matrix.
+     * Returns this graph's Laplacian matrix: `L = D - A` Where `D` is the
+     * degree matrix and `A` this adjacency matrix.
      *
      * @remarks
-     * - {@link https://en.wikipedia.org/wiki/Laplacian_matrix}
-     * - {@link https://en.wikipedia.org/wiki/Discrete_Laplace_operator}
+     * References:
+     * - https://en.wikipedia.org/wiki/Laplacian_matrix
+     * - https://en.wikipedia.org/wiki/Discrete_Laplace_operator
      *
      * @param deg - degree type for {@link AdjacencyMatrix.degreeMat}
      */
@@ -144,10 +146,11 @@ export class AdjacencyMatrix extends CSR {
     }
 }
 /**
- * Creates an adjacency matrix backed by a sparse {@link @thi.ng/sparse#CSR}
- * matrix, optionally initialize with given edge pairs. Each edge is a `[src,
- * dest]` tuple. If `undirected` is true (default: false), creates symmetrical
- * edges (i.e. undirected graph).
+ * Creates an adjacency matrix backed by a sparse
+ * [`CSR`](https://docs.thi.ng/umbrella/sparse/classes/CSR.html) matrix,
+ * optionally initialize with given edge pairs. Each edge is a `[src, dest]`
+ * tuple. If `undirected` is true (default: false), creates symmetrical edges
+ * (i.e. undirected graph).
  *
  * @param n - max number of vertices
  * @param edges - edge pairs