@rimbu/graph

@rimbu/graph

A Graph is a data structure consisting of nodes that can be connected through edges. Each node has a unique value or identifier. Edges can be directed, in which case we will call it an Arrow Graph, or undirected, in which case we will call it an Edge Graph. Furthermore, edges and arrows can also have values, in which case we call it a Valued Graph.

This package exports the following main types:

Name	Description
ArrowGraph<N>	a generic directed graph with nodes of type N
ArrowGraphHashed<N>	a directed graph with hashed nodes of type N
ArrowGraphSorted<N>	a directed graph with sorted nodes of type N
EdgeGraph<N>	a generic undirected graph with nodes of type N
EdgeGraphHashed<N>	an undirected graph with hashed nodes of type N
EdgeGraphSorted<N>	an undirected graph with sorted nodes of type N
Graph<N>	a generic graph with nodes of type N
ValuedGraph<N, V>	a generic graph with nodes of type N and edges with value type V
VariantGraph<N>	a generic type-variant graph with nodes of type N
VariantValuedGraph<N, V>	a generic type-variant graph with nodes of type N and edges with value type V

For complete documentation please visit the Graph page Rimbu Docs, or directly see the Rimbu Graph API Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

Compabitity

• Node >= 16
• Deno
• Bun >= 0.6.0
• Web

Yarn / NPM / Bun

For convenience, all main types are also exported through @rimbu/core.

To install this package only:

For yarn:

yarn add @rimbu/graph

For npm:

npm i @rimbu/graph

For bun:

bun add @rimbu/graph

Deno

For Deno, the following approach is recommended:

In the root folder of your project, create or edit a file called import_map.json with the following contents (where you should replace x.y.z with the desired version of Rimbu):

{
  "imports": {
    "@rimbu/": "https://deno.land/x/rimbu@x.y.z/"
  }
}

Note: The trailing slashes are important!

In this way you can use relative imports from Rimbu in your code, like so:

import { List } from '@rimbu/core/mod.ts';
import { HashMap } from '@rimbu/hashed/mod.ts';

Note that for sub-packages, due to conversion limitations it is needed to import the index.ts instead of mod.ts, like so:

import { HashMap } from '@rimbu/hashed/map/index.ts';

To run your script (let's assume the entry point is in src/main.ts):

deno run --import-map import_map.json src/main.ts

Usage

import { EdgeGraphSorted } from '@rimbu/graph';

console.log(EdgeGraphSorted.of([1, 2], [2, 3], [3, 1], [5]).toString());

Author

Arvid Nicolaas

Contributing

Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.

Contributors

Made with contributors-img.

License

Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.

See LICENSE for more information.