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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgrapht-core Show documentation
There is a newer version: 1.5.2
/*
 * (C) Copyright 2003-2018, by Barak Naveh 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 org.jgrapht.graph;

import org.jgrapht.*;
import org.jgrapht.graph.builder.*;
import org.jgrapht.util.*;

import java.util.function.*;

/**
 * A pseudograph. A pseudograph is a non-simple undirected graph in which both graph loops and
 * multiple (parallel) edges are permitted. If you're unsure about pseudographs, see:
 * 
 * http://mathworld.wolfram.com/Pseudograph.html.
 * 
 * @param  the graph vertex type
 * @param  the graph edge type
 */
public class Pseudograph
    extends
    AbstractBaseGraph
{
    private static final long serialVersionUID = -7574564204896552581L;

    /**
     * Creates a new graph.
     *
     * @param edgeClass class on which to base the edge supplier
     */
    public Pseudograph(Class edgeClass)
    {
        this(null, SupplierUtil.createSupplier(edgeClass), false);
    }

    /**
     * Creates a new graph.
     * 
     * @param vertexSupplier the vertex supplier, can be null
     * @param edgeSupplier the edge supplier, can be null
     * @param weighted whether the graph is weighted or not
     */
    public Pseudograph(Supplier vertexSupplier, Supplier edgeSupplier, boolean weighted)
    {
        super(
            vertexSupplier, edgeSupplier,
            new DefaultGraphType.Builder()
                .undirected().allowMultipleEdges(true).allowSelfLoops(true).weighted(weighted)
                .build());
    }

    /**
     * Create a builder for this kind of graph.
     * 
     * @param edgeClass class on which to base factory for edges
     * @param  the graph vertex type
     * @param  the graph edge type
     * @return a builder for this kind of graph
     */
    public static  GraphBuilder> createBuilder(
        Class edgeClass)
    {
        return new GraphBuilder<>(new Pseudograph<>(edgeClass));
    }

    /**
     * Create a builder for this kind of graph.
     * 
     * @param edgeSupplier the edge supplier of the new graph
     * @param  the graph vertex type
     * @param  the graph edge type
     * @return a builder for this kind of graph
     */
    public static  GraphBuilder> createBuilder(Supplier edgeSupplier)
    {
        return new GraphBuilder<>(new Pseudograph<>(null, edgeSupplier, false));
    }

    /**
     * Creates a new graph with the specified edge factory.
     *
     * @param ef the edge factory of the new graph.
     * @deprecated Use suppliers instead
     */
    @Deprecated
    public Pseudograph(EdgeFactory ef)
    {
        this(ef, false);
    }

    /**
     * Creates a new graph with the specified edge factory.
     *
     * @param weighted if true the graph supports edge weights
     * @param ef the edge factory of the new graph.
     * @deprecated Use suppliers instead
     */
    @Deprecated
    public Pseudograph(EdgeFactory ef, boolean weighted)
    {
        super(ef, false, true, true, weighted);
    }

    /**
     * Create a builder for this kind of graph.
     * 
     * @param ef the edge factory of the new graph
     * @param  the graph vertex type
     * @param  the graph edge type
     * @return a builder for this kind of graph
     * @deprecated Use suppliers instead
     */
    @Deprecated
    public static  GraphBuilder> createBuilder(EdgeFactory ef)
    {
        return new GraphBuilder<>(new Pseudograph<>(ef));
    }
}

// End Pseudograph.java