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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgrapht-jdk1.5
JGraphT is a free Java graph library that provides mathematical graph-theory objects and algorithms
The newest version!
/* ==========================================
 * 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-2007, by Barak Naveh and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */
/* -----------------------
 * UndirectedSubgraph.java
 * -----------------------
 * (C) Copyright 2003-2007, by Barak Naveh and Contributors.
 *
 * Original Author:  Barak Naveh
 * Contributor(s):   Christian Hammer
 *
 * $Id: UndirectedSubgraph.java 586 2008-01-27 23:30:50Z perfecthash $
 *
 * 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
{
    //~ Static fields/initializers ---------------------------------------------

    private static final long serialVersionUID = 3256728359772631350L;

    //~ Constructors -----------------------------------------------------------

    /**
     * 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);
    }

    //~ Methods ----------------------------------------------------------------

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

        ((UndirectedGraph) getBase()).degreeOf(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