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

Go to download
/*
 * (C) Copyright 2003-2021, by Barak Naveh and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * See the CONTRIBUTORS.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the
 * GNU Lesser General Public License v2.1 or later
 * which is available at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
 */
package org.jgrapht.graph;

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

import java.util.function.*;

/**
 * A weighted multigraph. A weighted multigraph is a non-simple undirected graph in which no loops
 * are permitted, but multiple (parallel) edges between any two vertices are. The edges of a
 * weighted multigraph have weights. If you're unsure about multigraphs, see:
 * 
 * http://mathworld.wolfram.com/Multigraph.html.
 * 
 * @param  the graph vertex type
 * @param  the graph edge type
 */
public class WeightedMultigraph
    extends
    Multigraph
{
    private static final long serialVersionUID = -6009321659287373874L;

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

    /**
     * Creates a new graph.
     * 
     * @param vertexSupplier the vertex supplier, can be null
     * @param edgeSupplier the edge supplier, can be null
     */
    public WeightedMultigraph(Supplier vertexSupplier, Supplier edgeSupplier)
    {
        super(vertexSupplier, edgeSupplier, true);
    }

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

    /**
     * Create a builder for this kind of graph.
     * 
     * @param edgeSupplier the edge supplier
     * @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 WeightedMultigraph<>(null, edgeSupplier));
    }

}