@thi.ng/adjacency 2.4.1 → 2.5.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-19T08:38:06Z
+- **Last updated**: 2023-10-23T07:37:37Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,18 @@ 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.
 
+## [2.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/adjacency@2.5.0) (2023-10-19)
+
+#### 🚀 Features
+
+- explicit version bump for @firfi's recent additions ([#400](https://github.com/thi-ng/umbrella/issues/400)) ([0d00025](https://github.com/thi-ng/umbrella/commit/0d00025))
+  - see: [2fd123d741586fe29a8cc63b7aa30f3ea9d35ab2](https://github.com/thi-ng/umbrella/commit/2fd123d741586fe29a8cc63b7aa30f3ea9d35ab2)
+  - update readme with API examples
+
+#### 🩹 Bug fixes
+
+- fix AdjacencyBitMatrix.numVertices() ([bd034ab](https://github.com/thi-ng/umbrella/commit/bd034ab))
+
 ## [2.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/adjacency@2.4.0) (2023-10-18)
 
 #### 🚀 Features

package/README.md

@@ -19,6 +19,7 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
 - [API](#api)
+  - [Basic usage](#basic-usage)
 - [Authors](#authors)
 - [License](#license)
 
@@ -102,6 +103,84 @@ A selection:
 
 TODO
 
+### Basic usage
+
+```ts tangle:export/readme.ts
+import { defAdjBitMatrix, type Edge } from "@thi.ng/adjacency";
+
+// relationships
+const rels = {
+    a: ["b", "c"],
+    b: ["d"],
+    c: ["d", "e"],
+    e: ["a", "d", "b"],
+};
+
+// form set of unique node IDs
+const nodeIDs = [
+    ...new Set(Object.entries(rels).flatMap(([id, rels]) => [id, ...rels])),
+];
+
+// the current adjacency matrix impls only support numeric node IDs
+// therefore, we first map node names to numeric IDs
+const index = new Map(nodeIDs.map((id, i) => [id, i]));
+
+// transform relationships into sequence of edges (aka `[from,to]` tuples)
+const edges = Object.entries(rels).flatMap(([id, rels]) =>
+    rels.map((x) => <Edge>[index.get(id), index.get(x)])
+);
+
+// build adjacency matrix, treat as undirected graph
+// edges can also be added/removed later
+const graph = defAdjBitMatrix(nodeIDs.length, edges, true);
+
+// graph queries
+console.log("edges:", graph.numEdges(), "verts:", graph.numVertices());
+// edges: 8 verts: 5
+
+// check if vertex/node is present in graph
+// (this is implementation specific and for the bitmatrix backed version here
+// only true if the vertex has at least 1 edge...)
+console.log(graph.hasVertex(index.get("d")!));
+// true
+
+// are `a` and `d` connected?
+console.log(graph.hasEdge(index.get("a")!, index.get("d")!));
+// false
+
+// number of connected nodes for `a`
+// (in directed graphs, there's also possibility to distinguish between in/out/inout)
+console.log(graph.degree(index.get("a")!));
+// 3
+
+// neighbors of `a` (with reverse lookup of node names)
+console.log(graph.neighbors(index.get("a")!).map((x) => nodeIDs[x]));
+// [ 'b', 'c', 'e' ]
+
+// serialize to GraphViz DOT format (see result visualization below)
+console.log(graph.toDot(nodeIDs));
+// graph g {
+// "d"--"e";
+// "c"--"d";
+// "c"--"e";
+// "b"--"d";
+// "b"--"e";
+// "a"--"b";
+// "a"--"c";
+// "a"--"e";
+// }
+
+// resize to new capacity & add add/remove vertices/edges
+graph.resize(10);
+
+graph.addEdge(4, 5);
+graph.removeEdge(0, 1);
+```
+
+GraphViz visualization of the above example graph:
+
+![example graph](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/adjacency/readme.png)
+
 ## Authors
 
 - [Karsten Schmidt](https://thi.ng) (Main author)

package/binary.js

@@ -27,7 +27,7 @@ export class AdjacencyBitMatrix {
         return this.numE;
     }
     numVertices() {
-        return this.mat.n;
+        return this.mat.m;
     }
     /**
      * Resizes matrix to new size given.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/adjacency",
-  "version": "2.4.1",
+  "version": "2.5.1",
   "description": "Sparse & bitwise adjacency matrices, lists and selected traversal algorithms for directed & undirected graphs",
   "type": "module",
   "module": "./index.js",
@@ -37,20 +37,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.5",
-    "@thi.ng/arrays": "^2.6.3",
-    "@thi.ng/bitfield": "^2.3.0",
-    "@thi.ng/dcons": "^3.2.64",
-    "@thi.ng/errors": "^2.3.5",
-    "@thi.ng/sparse": "^0.3.69"
+    "@thi.ng/api": "^8.9.6",
+    "@thi.ng/arrays": "^2.6.4",
+    "@thi.ng/bitfield": "^2.3.1",
+    "@thi.ng/dcons": "^3.2.65",
+    "@thi.ng/errors": "^2.3.6",
+    "@thi.ng/sparse": "^0.3.70"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.36.4",
-    "@thi.ng/testament": "^0.3.23",
-    "@thi.ng/vectors": "^7.7.19",
-    "rimraf": "^5.0.1",
+    "@microsoft/api-extractor": "^7.38.0",
+    "@thi.ng/testament": "^0.3.24",
+    "@thi.ng/vectors": "^7.7.20",
+    "rimraf": "^5.0.5",
     "tools": "^0.0.1",
-    "typedoc": "^0.25.0",
+    "typedoc": "^0.25.2",
     "typescript": "^5.2.2"
   },
   "keywords": [
@@ -125,5 +125,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "ae301a8a5f13f518dec04a975479c6e779a8ca9e\n"
+  "gitHead": "8d46d9326a9f9b81d65e7e274446f5964f9942ac\n"
 }