com.salesforce.jgrapht.graph.UndirectedMaskSubgraph Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright 2007-2017, by France Telecom and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * 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.
 */
package com.salesforce.jgrapht.graph;

import java.util.function.*;

import com.salesforce.jgrapht.*;

/**
 * An undirected graph that is a {@link MaskSubgraph} of another graph.
 *
 * @param  the graph vertex type
 * @param  the graph edge type
 *
 * @author Guillaume Boulmier
 * @since July 5, 2007
 */
public class UndirectedMaskSubgraph
    extends MaskSubgraph
    implements UndirectedGraph
{
    /**
     * Create a new undirected {@link MaskSubgraph} of another graph.
     * 
     * @param base the base graph
     * @param mask vertices and edges to exclude in the subgraph. If a vertex/edge is masked, it is
     *        as if it is not in the subgraph.
     * @deprecated in favor of using lambdas
     */
    @Deprecated
    public UndirectedMaskSubgraph(UndirectedGraph base, MaskFunctor mask)
    {
        super(base, mask);
    }

    /**
     * Create a new undirected {@link MaskSubgraph} of another graph.
     *
     * @param base the base graph
     * @param vertexMask vertices to exclude in the subgraph. If a vertex is masked, it is as if it
     *        is not in the subgraph. Edges incident to the masked vertex are also masked.
     * @param edgeMask edges to exclude in the subgraph. If an edge is masked, it is as if it is not
     *        in the subgraph.
     */
    public UndirectedMaskSubgraph(
        UndirectedGraph base, Predicate vertexMask, Predicate edgeMask)
    {
        super(base, vertexMask, edgeMask);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int degreeOf(V vertex)
    {
        return edgesOf(vertex).size();
    }

}

// End UndirectedMaskSubgraph.java