IGraph
Defined in: packages/data/src/graph/igraph.ts:10
An undirected graph over nodes of type N, with optional edge labels E.
Edge weights stay a caller-supplied label; the ordering used by a weighted algorithm belongs to the algorithm implementation, not to this representation.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”N
E extends DefinedValue | void = void
Methods
Section titled “Methods”addEdge()
Section titled “addEdge()”addEdge(
from,to,label):void
Defined in: packages/data/src/graph/igraph.ts:19
Parameters
Section titled “Parameters”N
N
E
Returns
Section titled “Returns”void
addNode()
Section titled “addNode()”addNode(
node):void
Defined in: packages/data/src/graph/igraph.ts:13
Parameters
Section titled “Parameters”N
Returns
Section titled “Returns”void
addNodes()
Section titled “addNodes()”addNodes(
nodes):void
Defined in: packages/data/src/graph/igraph.ts:14
Parameters
Section titled “Parameters”Iterable<N>
Returns
Section titled “Returns”void
degree()
Section titled “degree()”degree(
node):number
Defined in: packages/data/src/graph/igraph.ts:26
Parameters
Section titled “Parameters”N
Returns
Section titled “Returns”number
deleteEdge()
Section titled “deleteEdge()”deleteEdge(
from,to):boolean
Defined in: packages/data/src/graph/igraph.ts:20
Parameters
Section titled “Parameters”N
N
Returns
Section titled “Returns”boolean
deleteNode()
Section titled “deleteNode()”deleteNode(
node):boolean
Defined in: packages/data/src/graph/igraph.ts:15
Parameters
Section titled “Parameters”N
Returns
Section titled “Returns”boolean
edgeCount()
Section titled “edgeCount()”edgeCount():
number
Defined in: packages/data/src/graph/igraph.ts:12
Returns
Section titled “Returns”number
edgeLabel()
Section titled “edgeLabel()”edgeLabel(
from,to):E|undefined
Defined in: packages/data/src/graph/igraph.ts:22
Parameters
Section titled “Parameters”N
N
Returns
Section titled “Returns”E | undefined
edges()
Section titled “edges()”edges():
IterableIterator<readonly [N,N,E]>
Defined in: packages/data/src/graph/igraph.ts:23
Returns
Section titled “Returns”IterableIterator<readonly [N, N, E]>
hasEdge()
Section titled “hasEdge()”hasEdge(
from,to):boolean
Defined in: packages/data/src/graph/igraph.ts:21
Parameters
Section titled “Parameters”N
N
Returns
Section titled “Returns”boolean
hasNode()
Section titled “hasNode()”hasNode(
node):boolean
Defined in: packages/data/src/graph/igraph.ts:16
Parameters
Section titled “Parameters”N
Returns
Section titled “Returns”boolean
neighbors()
Section titled “neighbors()”neighbors(
node):IterableIterator<N>
Defined in: packages/data/src/graph/igraph.ts:25
Parameters
Section titled “Parameters”N
Returns
Section titled “Returns”IterableIterator<N>
nodeCount()
Section titled “nodeCount()”nodeCount():
number
Defined in: packages/data/src/graph/igraph.ts:11
Returns
Section titled “Returns”number
nodes()
Section titled “nodes()”nodes():
IterableIterator<N>
Defined in: packages/data/src/graph/igraph.ts:17
Returns
Section titled “Returns”IterableIterator<N>