<T, N>(walker: Walker<T, N>): Iterable<T>Returns an iterator over the indices in the walker.
Example (Iterating walker indices)
import { Graph } from "effect"
const graph = Graph.directed<string, number>((mutable) => {
const a = Graph.addNode(mutable, "A")
const b = Graph.addNode(mutable, "B")
Graph.addEdge(mutable, a, b, 1)
})
const dfs = Graph.dfs(graph, { start: [0] })
const indices = Array.from(Graph.indices(dfs))
console.log(indices) // [0, 1]iterators
Source effect/Graph.ts:41341 lines
export const const indices: <T, N>(
walker: Walker<T, N>
) => Iterable<T>
Returns an iterator over the indices in the walker.
Example (Iterating walker indices)
import { Graph } from "effect"
const graph = Graph.directed<string, number>((mutable) => {
const a = Graph.addNode(mutable, "A")
const b = Graph.addNode(mutable, "B")
Graph.addEdge(mutable, a, b, 1)
})
const dfs = Graph.dfs(graph, { start: [0] })
const indices = Array.from(Graph.indices(dfs))
console.log(indices) // [0, 1]
indices = <function (type parameter) T in <T, N>(walker: Walker<T, N>): Iterable<T>T, function (type parameter) N in <T, N>(walker: Walker<T, N>): Iterable<T>N>(walker: Walker<T, N>(parameter) walker: {
visit: <U>(f: (index: T, data: N) => U) => Iterable<U>;
}
class Walker<T, N>class Walker {
visit: <U>(f: (index: T, data: N) => U) => Iterable<U>;
}
Represents an iterable wrapper used by graph traversal and listing APIs.
Details
A Walker yields [index, data] pairs lazily and can be viewed as just the
indices, just the values, or mapped entries with indices, values,
entries, and visit.
Example (Working with node walkers)
import { Graph } from "effect"
const graph = Graph.directed<string, number>((mutable) => {
const a = Graph.addNode(mutable, "A")
const b = Graph.addNode(mutable, "B")
Graph.addEdge(mutable, a, b, 1)
})
// Both traversal and element iterators return NodeWalker
const dfsNodes: Graph.NodeWalker<string> = Graph.dfs(graph, { start: [0] })
const allNodes: Graph.NodeWalker<string> = Graph.nodes(graph)
// Common interface for working with node iterables
function processNodes<N>(nodeIterable: Graph.NodeWalker<N>): Array<number> {
return Array.from(Graph.indices(nodeIterable))
}
// Access node data using values() or entries()
const nodeData = Array.from(Graph.values(dfsNodes)) // ["A", "B"]
const nodeEntries = Array.from(Graph.entries(allNodes)) // [[0, "A"], [1, "B"]]
Walker<function (type parameter) T in <T, N>(walker: Walker<T, N>): Iterable<T>T, function (type parameter) N in <T, N>(walker: Walker<T, N>): Iterable<T>N>): interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) T in <T, N>(walker: Walker<T, N>): Iterable<T>T> => walker: Walker<T, N>(parameter) walker: {
visit: <U>(f: (index: T, data: N) => U) => Iterable<U>;
}
Walker<T, N>.visit: <T>(f: (index: T, data: N) => T) => Iterable<T>Visits each element and maps it to a value using the provided function.
Details
Takes a function that receives the index and data,
and returns an iterable of the mapped values. Skips elements that
no longer exist in the graph.
Example (Visiting walker elements)
import { Graph } from "effect"
const graph = Graph.directed<string, number>((mutable) => {
const a = Graph.addNode(mutable, "A")
const b = Graph.addNode(mutable, "B")
Graph.addEdge(mutable, a, b, 1)
})
const dfs = Graph.dfs(graph, { start: [0] })
// Map to just the node data
const values = Array.from(dfs.visit((index, data) => data))
console.log(values) // ["A", "B"]
// Map to custom objects
const custom = Array.from(
dfs.visit((index, data) => ({ id: index, name: data }))
)
console.log(custom) // [{ id: 0, name: "A" }, { id: 1, name: "B" }]
visit((index: Tindex, _: N_) => index: Tindex)