package berack96.sim.util.graph; import berack96.sim.util.graph.visit.Dijkstra; import berack96.sim.util.graph.visit.Tarjan; import berack96.sim.util.graph.visit.VisitStrategy; import java.util.*; import java.util.concurrent.atomic.AtomicInteger; import java.util.function.Consumer; /** * Graph that uses HashMap for vertices and edges
* More specifically it utilizes a Map containing all the vertices mapped to all their edges
* Technically this version of the graph combine the fast adding/removing of the edges of the Matrix implementation, * with the low memory and fast adding/removing of vertices of the Linked List implementation.
* This happen if the HashMap is not reallocated. So in the end each operation of adding or removing has O(n) * * @param the vertices * @param the weight of the edges */ public class MapGraph implements Graph { /** * Map that contains the edges from a vertex to another
* The first vertex is the vertex where start the edge, the second one is where the edge goes
* If an edge exist, then it's weight is returned */ private final Map> edges = new HashMap<>(); /** * Need this variable for not calculating each time the SCC or the cyclic part if the graph doesn't change */ private Tarjan tarjan = null; /** * Need this variable for not calculating each time the distance from a vertex to all his destinations if the graph doesn't change */ private Map> dijkstra = null; @Override public boolean isCyclic() { return stronglyConnectedComponents().size() != numberOfVertices(); } @Override public boolean isDAG() { return !isCyclic(); } @Override public void addVertex(V vertex) throws NullPointerException { checkNull(vertex); graphChanged(); edges.put(vertex, new HashMap<>()); } @Override public boolean addVertexIfAbsent(V vertex) throws NullPointerException { if (contains(vertex)) return false; addVertex(vertex); return true; } @Override public void addAllVertices(Set vertices) throws NullPointerException { checkNull(vertices); vertices.forEach(this::addVertexIfAbsent); } @Override public void removeVertex(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); graphChanged(); edges.remove(vertex); edges.forEach((v, map) -> map.remove(vertex)); } @Override public void removeAllVertex() { graphChanged(); edges.clear(); } @Override public boolean contains(V vertex) throws NullPointerException { checkNull(vertex); return edges.containsKey(vertex); } @Override public W addEdge(V vertex1, V vertex2, W weight) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex1); checkNullAndExist(vertex2); checkNull(weight); graphChanged(); return edges.get(vertex1).put(vertex2, weight); } @Override public W addEdgeAndVertices(V vertex1, V vertex2, W weight) throws NullPointerException { addVertexIfAbsent(vertex1); addVertexIfAbsent(vertex2); return addEdge(vertex1, vertex2, weight); } @Override public void addAllEdges(Set> edges) throws NullPointerException { edges.forEach((edge) -> addEdgeAndVertices(edge.getSource(), edge.getDestination(), edge.getWeight())); } @Override public W getWeight(V vertex1, V vertex2) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex1); checkNullAndExist(vertex2); return edges.get(vertex1).get(vertex2); } @Override public void removeEdge(V vertex1, V vertex2) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex1); checkNullAndExist(vertex2); graphChanged(); edges.get(vertex1).remove(vertex2); } @Override public void removeAllInEdge(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); graphChanged(); edges.forEach((v, map) -> map.remove(vertex)); } @Override public void removeAllOutEdge(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); graphChanged(); edges.put(vertex, new HashMap<>()); } @Override public void removeAllEdge(V vertex) throws NullPointerException, IllegalArgumentException { removeVertex(vertex); addVertex(vertex); } @Override public void removeAllEdge() { graphChanged(); edges.forEach((v, map) -> map.clear()); } @Override public boolean containsEdge(V vertex1, V vertex2) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex1); checkNullAndExist(vertex2); return edges.get(vertex1).get(vertex2) != null; } @Override public Set vertices() { return new HashSet<>(edges.keySet()); } @Override public Set> edges() { Set> allEdges = new HashSet<>(); edges.forEach((source, map) -> map.forEach((destination, weight) -> allEdges.add(new Edge<>(source, destination, weight)))); return allEdges; } @Override public Set> edgesOf(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); Set> set = new HashSet<>(); edges.forEach((source, map) -> map.forEach((destination, weight) -> { if (destination.equals(vertex) || source.equals(vertex)) set.add(new Edge<>(source, destination, weight)); })); return set; } @Override public Set getChildren(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); return new HashSet<>(edges.get(vertex).keySet()); } @Override public Map getChildrenAndWeight(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); return new HashMap<>(edges.get(vertex)); } @Override public Set getAncestors(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); Set set = new HashSet<>(); edges.forEach((v, map) -> { if (map.containsKey(vertex)) set.add(v); }); return set; } @Override public int degreeIn(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); AtomicInteger sum = new AtomicInteger(); edges.forEach((v, map) -> { if (map.containsKey(vertex)) sum.getAndIncrement(); }); return sum.get(); } @Override public int degreeOut(V vertex) throws NullPointerException, IllegalArgumentException { checkNullAndExist(vertex); return edges.get(vertex).size(); } @Override public int degree(V vertex) throws NullPointerException, IllegalArgumentException { return degreeIn(vertex) + degreeOut(vertex); } @Override public int numberOfVertices() { return edges.size(); } @Override public int numberOfEdges() { AtomicInteger sum = new AtomicInteger(0); edges.forEach((v, map) -> sum.getAndAdd(map.size())); return sum.get(); } @Override public void visit(V source, VisitStrategy strategy, Consumer visit) throws NullPointerException, IllegalArgumentException { strategy.visit(this, source, visit); } @Override public Graph transpose() { Graph graph = new MapGraph<>(); for (V vertex : edges.keySet()) graph.addVertex(vertex); edges.forEach((source, map) -> map.forEach((destination, weight) -> graph.addEdge(destination, source, weight))); return graph; } @Override public List topologicalSort() throws UnsupportedOperationException { if (!isDAG()) throw new UnsupportedOperationException(NOT_DAG); return getTarjan().getTopologicalSort(); } @Override public Set> stronglyConnectedComponents() { return getTarjan().getSCC(); } @Override public Graph subGraph(V source, int depth) throws NullPointerException, IllegalArgumentException { Graph sub = new MapGraph<>(); Set vertices = new HashSet<>(); int finalDepth = depth > 0 ? depth : 0; VisitStrategy strategy = (graph, sourceVertex, visit) -> { int currentDepth = 0; final LinkedList> toVisitChildren = new LinkedList<>(); toVisitChildren.add(new AbstractMap.SimpleEntry<>(sourceVertex, 0)); vertices.add(source); while (!toVisitChildren.isEmpty() && currentDepth + 1 <= finalDepth) { final Map.Entry current = toVisitChildren.removeFirst(); currentDepth = current.getValue() + 1; final int finalCurrentDepth = currentDepth; for (V child : graph.getChildren(current.getKey())) if (!vertices.contains(child)) { toVisitChildren.addLast(new AbstractMap.SimpleEntry<>(child, finalCurrentDepth)); vertices.add(child); } } }; strategy.visit(this, source, null); sub.addAllVertices(vertices); for (V vertex : vertices) getChildrenAndWeight(vertex).forEach((child, weight) -> { try { sub.addEdge(vertex, child, weight); } catch (Exception ignored) { } }); return sub; } @Override public List> distance(V source, V destination) throws NullPointerException, IllegalArgumentException, UnsupportedOperationException { checkNullAndExist(source); checkNullAndExist(destination); Dijkstra dijkstra = getDijkstra(source); List> path = dijkstra.getLastDistance().get(destination); if (path == null) throw new UnsupportedOperationException(NOT_CONNECTED); return new ArrayList<>(path); } @Override public Map>> distance(V source) throws NullPointerException, IllegalArgumentException { checkNullAndExist(source); return new HashMap<>(getDijkstra(source).getLastDistance()); } @Override public Iterator iterator() { return edges.keySet().iterator(); } /** * Simple function that set all the memory vars at null if the graph changed */ private void graphChanged() { tarjan = null; dijkstra = null; } private Dijkstra getDijkstra(V source) { if (dijkstra == null) dijkstra = new HashMap<>(); if (dijkstra.get(source) == null) { Dijkstra newDijkstra = new Dijkstra<>(); newDijkstra.visit(this, source, null); dijkstra.put(source, newDijkstra); } return dijkstra.get(source); } private Tarjan getTarjan() { if (tarjan == null) { tarjan = new Tarjan<>(); tarjan.visit(this, null, null); } return tarjan; } private void checkNull(Object object) { if (object == null) throw new NullPointerException(PARAM_NULL); } private void checkNullAndExist(V vertex) { checkNull(vertex); if (!edges.containsKey(vertex)) throw new IllegalArgumentException(VERTEX_NOT_CONTAINED); } }