edu.uci.ics.jung.graph.UndirectedSparseMultigraph Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jung-graph-impl Show documentation
Graph implementations for the JUNG project
The newest version!
/*
 * Created on Mar 6, 2007
 *
 * Copyright (c) 2007, The JUNG Authors 
 *
 * All rights reserved.
 *
 * This software is open-source under the BSD license; see either
 * "license.txt" or
 * https://github.com/jrtom/jung/blob/master/LICENSE for a description.
 */
/*
 * Created on Oct 18, 2005
 *
 * Copyright (c) 2005, The JUNG Authors 
 *
 * All rights reserved.
 *
 * This software is open-source under the BSD license; see either
 * "license.txt" or
 * https://github.com/jrtom/jung/blob/master/LICENSE for a description.
 */
package edu.uci.ics.jung.graph;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import com.google.common.base.Supplier;

import edu.uci.ics.jung.graph.util.EdgeType;
import edu.uci.ics.jung.graph.util.Pair;

/**
 * An implementation of UndirectedGraph that is suitable for 
 * sparse graphs and permits parallel edges.
 */
@SuppressWarnings("serial")
public class UndirectedSparseMultigraph 
    extends AbstractTypedGraph
    implements UndirectedGraph, MultiGraph
{
    /**
     * @param  the vertex type for the graph Supplier
     * @param  the edge type for the graph Supplier
     * @return a {@code Supplier} that creates an instance of this graph type.
     */
    public static  Supplier> getFactory() {
        return new Supplier> () {

            public UndirectedGraph get() {
                return new UndirectedSparseMultigraph();
            }
        };
    }

    protected Map> vertices; // Map of vertices to adjacency sets
    protected Map> edges;    // Map of edges to incident vertex sets

    /**
     * Creates a new instance.
     */
    public UndirectedSparseMultigraph() {
    	super(EdgeType.UNDIRECTED);
        vertices = new HashMap>();
        edges = new HashMap>();
    }

    public Collection getEdges() {
        return Collections.unmodifiableCollection(edges.keySet());
    }

    public Collection getVertices() {
        return Collections.unmodifiableCollection(vertices.keySet());
    }

    public boolean containsVertex(V vertex) {
    	return vertices.keySet().contains(vertex);
    }
    
    public boolean containsEdge(E edge) {
    	return edges.keySet().contains(edge);
    }

    protected Collection getIncident_internal(V vertex)
    {
        return vertices.get(vertex);
    }
    
    public boolean addVertex(V vertex) {
        if(vertex == null) {
            throw new IllegalArgumentException("vertex may not be null");
        }
        if (!containsVertex(vertex))
        {
            vertices.put(vertex, new HashSet());
            return true;
        } else {
            return false;
        }
    }

    public boolean removeVertex(V vertex) {
        if (!containsVertex(vertex))
            return false;
        
        for (E edge : new ArrayList(getIncident_internal(vertex)))
            removeEdge(edge);
        
        vertices.remove(vertex);
        return true;
    }
    
    @Override
    public boolean addEdge(E edge, V v1, V v2, EdgeType edgeType) {
        return addEdge(edge, new Pair(v1, v2), edgeType);
    }
    
    @Override
    public boolean addEdge(E edge, Pair endpoints, EdgeType edge_type) 
    {
    	validateEdgeType(edge_type);
    	
        Pair new_endpoints = getValidatedEndpoints(edge, endpoints);
        if (new_endpoints == null)
            return false;
        
        V v1 = endpoints.getFirst();
        V v2 = endpoints.getSecond();

        edges.put(edge, new_endpoints);
        
        if (!containsVertex(v1))
            this.addVertex(v1);
        
        if (!containsVertex(v2))
            this.addVertex(v2);

        vertices.get(v1).add(edge);
        vertices.get(v2).add(edge);        
        
        return true;
    }

    public boolean removeEdge(E edge) {
        if (!containsEdge(edge))
            return false;
        
        Pair endpoints = getEndpoints(edge);
        V v1 = endpoints.getFirst();
        V v2 = endpoints.getSecond();
        
        // remove edge from incident vertices' adjacency sets
        vertices.get(v1).remove(edge);
        vertices.get(v2).remove(edge);

        edges.remove(edge);
        return true;
    }
    
    public Collection getInEdges(V vertex) {
        return this.getIncidentEdges(vertex);
    }

    public Collection getOutEdges(V vertex) {
        return this.getIncidentEdges(vertex);
    }

    public Collection getPredecessors(V vertex) {
        return this.getNeighbors(vertex);
    }

    public Collection getSuccessors(V vertex) {
        return this.getNeighbors(vertex);
    }

    public Collection getNeighbors(V vertex) {
        if (!containsVertex(vertex))
            return null;
        
        Set neighbors = new HashSet();
        for (E edge : getIncident_internal(vertex))
        {
            Pair endpoints = this.getEndpoints(edge);
            V e_a = endpoints.getFirst();
            V e_b = endpoints.getSecond();
            if (vertex.equals(e_a))
                neighbors.add(e_b);
            else
                neighbors.add(e_a);
        }
        
        return Collections.unmodifiableCollection(neighbors);
    }

    public Collection getIncidentEdges(V vertex) {
        if (!containsVertex(vertex))
            return null;
        
        return Collections.unmodifiableCollection(getIncident_internal(vertex));
    }

    @Override
    public E findEdge(V v1, V v2) {
        if (!containsVertex(v1) || !containsVertex(v2))
            return null;
        for (E edge : getIncident_internal(v1)) {
            Pair endpoints = this.getEndpoints(edge);
            V e_a = endpoints.getFirst();
            V e_b = endpoints.getSecond();
            if ((v1.equals(e_a) && v2.equals(e_b)) || (v1.equals(e_b) && v2.equals(e_a)))
                return edge;
        }
        return null;
    }

    public Pair getEndpoints(E edge) {
        return edges.get(edge);
    }

    public V getDest(E directed_edge) {
        return null;
    }

    public V getSource(E directed_edge) {
        return null;
    }

    public boolean isDest(V vertex, E edge) {
        return false;
    }

    public boolean isSource(V vertex, E edge) {
        return false;
    }

    public int getEdgeCount() {
        return edges.size();
    }

    public int getVertexCount() {
        return vertices.size();
    }

}