@graphty/algorithms / index / BipartiteMatchingOptions

Interface: BipartiteMatchingOptions

Defined in: indexed/matching.ts:17

Options of maximumBipartiteMatching and greedyBipartiteMatching.

Properties

arcs?

readonly optional arcs?: "out" | "both"

Defined in: indexed/matching.ts:34

Which arcs of a directed snapshot join a left node to a right one. "both" (default) ignores direction, as a matching does. "out" follows out-arcs of left nodes only, as the legacy functions do, and is also passed to isBipartite when the sides are inferred. Ignored on an undirected snapshot.

---

left?

readonly optional left?: U32 | NodeSet

Defined in: indexed/matching.ts:25

The left side. Given together with right, the two sides are used as they are and the graph is not tested for bipartiteness; a node on neither side is never matched. When either is missing both come from isBipartite: its first side is the left one. A side is a NodeSet (a plain array of indices, { mask } or { ids }); a bare Uint32Array is read as a NodeMask, as it always has been here, so pass indices in a Uint32Array as Array.from(indices).

---

right?

readonly optional right?: U32 | NodeSet

Defined in: indexed/matching.ts:27

The right side; see left.