org.jgrapht.alg.cycle.QueueBFSFundamentalCycleBasis Maven / Gradle / Ivy
/*
* (C) Copyright 2016-2023, by Dimitrios Michail and Contributors.
*
* JGraphT : a free Java graph-theory library
*
* See the CONTRIBUTORS.md file distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the
* GNU Lesser General Public License v2.1 or later
* which is available at
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
*
* SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
*/
package org.jgrapht.alg.cycle;
import org.jgrapht.*;
import java.util.*;
/**
* Generate a set of fundamental cycles by building a spanning tree (forest) using a straightforward
* implementation of BFS using a FIFO queue. The implementation first constructs the spanning forest
* and then builds the fundamental-cycles set. It supports graphs with self-loops and/or graphs with
* multiple (parallel) edges.
*
*
* For information on algorithms computing fundamental cycle bases see the following paper: Narsingh
* Deo, G. Prabhu, and M. S. Krishnamoorthy. Algorithms for Generating Fundamental Cycles in a
* Graph. ACM Trans. Math. Softw. 8, 1, 26-42, 1982.
*
*
*
* The total length of the fundamental-cycle set can be as large as $O(n^3)$ where $n$ is the number
* of vertices of the graph.
*
*
* @param the vertex type
* @param the edge type
*
* @author Dimitrios Michail
*/
public class QueueBFSFundamentalCycleBasis
extends AbstractFundamentalCycleBasis
{
/**
* Constructor
*
* @param graph the input graph
*/
public QueueBFSFundamentalCycleBasis(Graph graph)
{
super(graph);
}
/**
* Compute a spanning forest of the graph using a straightforward BFS implementation.
*
*
* The representation assumes that the map contains the predecessor edge of each vertex in the
* forest. The predecessor edge is the forest edge that was used to discover the vertex. If no
* such edge was used (the vertex is a leaf in the forest) then the corresponding entry must be
* null.
*
* @return a map representation of a spanning forest.
*/
@Override
protected Map computeSpanningForest()
{
Map pred = new HashMap<>();
ArrayDeque queue = new ArrayDeque<>();
for (V s : graph.vertexSet()) {
// loop over connected-components
if (pred.containsKey(s)) {
continue;
}
// add s in queue
pred.put(s, null);
queue.addLast(s);
// start traversal
while (!queue.isEmpty()) {
V v = queue.removeFirst();
for (E e : graph.edgesOf(v)) {
V u = Graphs.getOppositeVertex(graph, e, v);
if (!pred.containsKey(u)) {
pred.put(u, e);
queue.addLast(u);
}
}
}
}
return pred;
}
}