graphbox 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -10
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ GraphBox provides a toolkit for graph manipulation, analysis, and generation, sp
|
|
|
11
11
|
|
|
12
12
|
## Overview
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
GraphBox consolidates three previously separate BibGraph packages into a single, focused package:
|
|
15
15
|
|
|
16
16
|
- **graph-core**: Core graph interfaces and adapters
|
|
17
17
|
- **graph-expansion**: Graph expansion, traversal algorithms, and neighborhood exploration
|
|
@@ -20,7 +20,17 @@ Graph-Box consolidates three previously separate BibGraph packages into a single
|
|
|
20
20
|
## Installation
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
pnpm install
|
|
23
|
+
pnpm install graphbox
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## CLI
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx graphbox help # Show available commands
|
|
30
|
+
npx graphbox version # Show version
|
|
31
|
+
npx graphbox generate # Generate a graph from a specification
|
|
32
|
+
npx graphbox analyze # Analyze graph properties
|
|
33
|
+
npx graphbox validate # Validate a graph against constraints
|
|
24
34
|
```
|
|
25
35
|
|
|
26
36
|
## Key Features
|
|
@@ -30,7 +40,7 @@ pnpm install graph-box
|
|
|
30
40
|
`GraphAdapter` provides a bridge between different graph implementations, allowing you to use generic algorithms with your specific graph data structures.
|
|
31
41
|
|
|
32
42
|
```typescript
|
|
33
|
-
import { GraphAdapter } from '
|
|
43
|
+
import { GraphAdapter } from 'graphbox';
|
|
34
44
|
|
|
35
45
|
const adapter = new GraphAdapter(graph);
|
|
36
46
|
```
|
|
@@ -46,7 +56,7 @@ Multiple traversal algorithms for exploring graph neighborhoods:
|
|
|
46
56
|
- **Priority Queue** - Custom priority-based expansion
|
|
47
57
|
|
|
48
58
|
```typescript
|
|
49
|
-
import { bfs, dfs, extractEgoNetwork } from '
|
|
59
|
+
import { bfs, dfs, extractEgoNetwork } from 'graphbox';
|
|
50
60
|
|
|
51
61
|
const bfsResult = bfs(adapter, 'startNodeId');
|
|
52
62
|
const dfsResult = dfs(adapter, 'startNodeId');
|
|
@@ -68,7 +78,7 @@ const egoNetwork = extractEgoNetwork(adapter, {
|
|
|
68
78
|
Type-safe graph generation with mathematical constraint validation:
|
|
69
79
|
|
|
70
80
|
```typescript
|
|
71
|
-
import { generateGraph, validateGraph } from '
|
|
81
|
+
import { generateGraph, validateGraph } from 'graphbox';
|
|
72
82
|
|
|
73
83
|
const spec = {
|
|
74
84
|
type: 'complete',
|
|
@@ -90,7 +100,7 @@ const valid = validateGraph(graph, spec.constraints);
|
|
|
90
100
|
Mathematical constraint validation for graph properties:
|
|
91
101
|
|
|
92
102
|
```typescript
|
|
93
|
-
import { validateGraph, checkConstraints } from '
|
|
103
|
+
import { validateGraph, checkConstraints } from 'graphbox';
|
|
94
104
|
|
|
95
105
|
const isValid = validateGraph(graph, constraints);
|
|
96
106
|
```
|
|
@@ -100,7 +110,7 @@ const isValid = validateGraph(graph, constraints);
|
|
|
100
110
|
### Basic Traversal
|
|
101
111
|
|
|
102
112
|
```typescript
|
|
103
|
-
import { GraphAdapter, bfs } from '
|
|
113
|
+
import { GraphAdapter, bfs } from 'graphbox';
|
|
104
114
|
|
|
105
115
|
const graph = { /* your graph */ };
|
|
106
116
|
const adapter = new GraphAdapter(graph);
|
|
@@ -112,7 +122,7 @@ console.log(result.visited); // Array of visited node IDs
|
|
|
112
122
|
### Ego Network Extraction
|
|
113
123
|
|
|
114
124
|
```typescript
|
|
115
|
-
import { extractEgoNetwork } from '
|
|
125
|
+
import { extractEgoNetwork } from 'graphbox';
|
|
116
126
|
|
|
117
127
|
const adapter = new GraphAdapter(graph);
|
|
118
128
|
|
|
@@ -128,7 +138,7 @@ console.log(egoNetwork);
|
|
|
128
138
|
### Graph Generation
|
|
129
139
|
|
|
130
140
|
```typescript
|
|
131
|
-
import { generateGraph, GraphSpec } from '
|
|
141
|
+
import { generateGraph, GraphSpec } from 'graphbox';
|
|
132
142
|
|
|
133
143
|
const spec: GraphSpec = {
|
|
134
144
|
type: 'complete',
|
|
@@ -142,7 +152,7 @@ const graph = generateGraph(spec);
|
|
|
142
152
|
### Graph Validation
|
|
143
153
|
|
|
144
154
|
```typescript
|
|
145
|
-
import { validateGraph } from '
|
|
155
|
+
import { validateGraph } from 'graphbox';
|
|
146
156
|
|
|
147
157
|
const graph = { /* graph object */ };
|
|
148
158
|
const isValid = validateGraph(graph);
|
package/dist/cli.js
CHANGED
package/package.json
CHANGED