org.jgrapht.graph.UndirectedSubgraph Maven / Gradle / Ivy

/* ==========================================
 * JGraphT : a free Java graph-theory library
 * ==========================================
 *
 * Project Info:  http://jgrapht.sourceforge.net/
 * Project Creator:  Barak Naveh (http://sourceforge.net/users/barak_naveh)
 *
 * (C) Copyright 2003-2008, by Barak Naveh and Contributors.
 *
 * This program and the accompanying materials are dual-licensed under
 * either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation, or (at your option) any
 * later version.
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation.
 */
/* -----------------------
 * UndirectedSubgraph.java
 * -----------------------
 * (C) Copyright 2003-2008, by Barak Naveh and Contributors.
 *
 * Original Author:  Barak Naveh
 * Contributor(s):   Christian Hammer
 *
 * $Id$
 *
 * Changes
 * -------
 * 05-Aug-2003 : Initial revision (BN);
 * 06-Aug-2005 : Made generic (CH);
 *
 */
package org.jgrapht.graph;

import java.util.*;

import org.jgrapht.*;


/**
 * An undirected graph that is a subgraph on other graph.
 *
 * @see Subgraph
 */
public class UndirectedSubgraph
    extends Subgraph>
    implements UndirectedGraph
{
    

    private static final long serialVersionUID = 3256728359772631350L;

    

    /**
     * Creates a new undirected subgraph.
     *
     * @param base the base (backing) graph on which the subgraph will be based.
     * @param vertexSubset vertices to include in the subgraph. If 
     * null then all vertices are included.
     * @param edgeSubset edges to in include in the subgraph. If 
     * null then all the edges whose vertices found in the graph
     * are included.
     */
    public UndirectedSubgraph(
        UndirectedGraph base,
        Set vertexSubset,
        Set edgeSubset)
    {
        super(base, vertexSubset, edgeSubset);
    }

    

    /**
     * @see UndirectedGraph#degreeOf(Object)
     */
    public int degreeOf(V vertex)
    {
        assertVertexExist(vertex);

        int degree = 0;

        for (E e : getBase().edgesOf(vertex)) {
            if (containsEdge(e)) {
                degree++;

                if (getEdgeSource(e).equals(getEdgeTarget(e))) {
                    degree++;
                }
            }
        }

        return degree;
    }
}

// End UndirectedSubgraph.java