Calculates a bipartition of the given graph, if one exists.
Remarks
A graph is bipartite if its nodes can be divided into two partitions where no edges are between nodes of the same partition. Instead, every edge connects a node from the first with a node from the second partition.
Other Graph Connectivity Algorithms
yFiles for HTML supports a number of other analysis algorithms that partition the graph into components, based on various criteria.
- ConnectedComponents – Determines components defined by the existence of an undirected path between nodes
- StronglyConnectedComponents – Determines components defined by the existence of a directed path between nodes
- BiconnectedComponents – Determines components defined by the existence of at least two separate undirected paths between all nodes
- IndependentSets – Divides a graph into partitions where no nodes are connected within a partition
- KCoreComponents – Calculates the k-cores of an undirected input graph. The k-core of an undirected input graph consists of the subgraph components where each node has at least degree
k.
Examples
// prepare the bipartition algorithm
const algorithm = new Bipartition()
// run the algorithm
const result = algorithm.run(graph)
// highlight the nodes of the partitions with different styles
if (result.isBipartite) {
for (const node of result.firstPartition.nodes) {
graph.setStyle(node, firstPartitionStyle)
}
for (const node of result.secondPartition.nodes) {
graph.setStyle(node, secondPartitionStyle)
}
}Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.analysis.Bipartition
See Also
Constructors
Creates a new Bipartition instance.
Parameters
A map of options to pass to the method.
- subgraphNodes - ItemCollection<INode>
The collection of nodes which define a subset of the graph for the algorithms to work on. This option sets the subgraphNodes property on the created object.
- subgraphEdges - ItemCollection<IEdge>
The collection of edges which define a subset of the graph for the algorithms to work on. This option sets the subgraphEdges property on the created object.
Properties
Gets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
Remarks
If nothing is set, all edges of the graph will be processed.
If only the excludes are set all edges in the graph except those provided in the excludes are processed.
Note that edges which start or end at nodes which are not in the subgraphNodes are automatically not considered by the algorithm.
ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.
Examples
// configure the bipartition algorithm
const algorithm = new Bipartition({
// Ignore edges without target arrow heads
subgraphEdges: {
excludes: (edge) =>
edge.style instanceof PolylineEdgeStyle &&
edge.style.targetArrow === IArrow.NONE
}
})
// run the algorithm
const result = algorithm.run(graph)
// highlight the nodes of the partitions with different styles
if (result.isBipartite) {
for (const node of result.firstPartition.nodes) {
graph.setStyle(node, firstPartitionStyle)
}
for (const node of result.secondPartition.nodes) {
graph.setStyle(node, secondPartitionStyle)
}
}// configure the bipartition algorithm
const algorithm = new Bipartition({
// Ignore edges without target arrow heads
subgraphEdges: {
excludes: (edge: IEdge): boolean =>
edge.style instanceof PolylineEdgeStyle &&
edge.style.targetArrow === IArrow.NONE
}
})
// run the algorithm
const result = algorithm.run(graph)
// highlight the nodes of the partitions with different styles
if (result.isBipartite) {
for (const node of result.firstPartition.nodes) {
graph.setStyle(node, firstPartitionStyle)
}
for (const node of result.secondPartition.nodes) {
graph.setStyle(node, secondPartitionStyle)
}
}Gets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
Remarks
If nothing is set, all nodes of the graph will be processed.
If only the excludes are set all nodes in the graph except those provided in the excludes are processed.
ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.
Examples
// configure the bipartition algorithm
const algorithm = new Bipartition({
subgraphNodes: {
// only consider elliptical nodes in the graph
includes: (node) =>
node.style instanceof ShapeNodeStyle &&
node.style.shape === ShapeNodeShape.ELLIPSE,
// but ignore the first node, regardless of its shape
excludes: graph.nodes.first()
}
})
// run the algorithm
const result = algorithm.run(graph)
// highlight the nodes of the partitions with different styles
if (result.isBipartite) {
for (const node of result.firstPartition.nodes) {
graph.setStyle(node, firstPartitionStyle)
}
for (const node of result.secondPartition.nodes) {
graph.setStyle(node, secondPartitionStyle)
}
}// configure the bipartition algorithm
const algorithm = new Bipartition({
subgraphNodes: {
// only consider elliptical nodes in the graph
includes: (node: INode): boolean =>
node.style instanceof ShapeNodeStyle &&
node.style.shape === ShapeNodeShape.ELLIPSE,
// but ignore the first node, regardless of its shape
excludes: graph.nodes.first()
}
})
// run the algorithm
const result = algorithm.run(graph)
// highlight the nodes of the partitions with different styles
if (result.isBipartite) {
for (const node of result.firstPartition.nodes) {
graph.setStyle(node, firstPartitionStyle)
}
for (const node of result.secondPartition.nodes) {
graph.setStyle(node, secondPartitionStyle)
}
}Methods
Calculates a bipartition of the given graph, if one exists.
Complexity
O(|V| + |E|)
Parameters
A map of options to pass to the method.
- graph - IGraph
- The input graph to run the algorithm on.
Returns
- ↪BipartitionResult
- A BipartitionResult containing both partitions of
graph. If the graph is not bipartite, the resulting partitions are empty and isBipartite isfalse.
Throws
- Exception({ name: 'InvalidOperationError' })
- If the algorithm can't create a valid result due to an invalid graph structure or wrongly configured properties.