org.jgrapht.graph.IntrusiveEdgesSpecifics Maven / Gradle / Ivy
/*
* (C) Copyright 2017-2023, by Dimitrios Michail 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 java.io.*;
import java.util.*;
/**
* An interface for the set of intrusive edges of a graph.
*
*
* Since the library supports edges which can be any user defined object, we need to provide
* explicit support for storing vertex source, target and weight.
*
* @param the graph vertex type
* @param the graph edge type
*
* @author Dimitrios Michail
*/
public interface IntrusiveEdgesSpecifics
extends Serializable
{
/**
* Get the source vertex of an edge.
*
* @param e the edge
* @return the source vertex
*/
V getEdgeSource(E e);
/**
* Get the target vertex of an edge.
*
* @param e the edge
* @return the target vertex
*/
V getEdgeTarget(E e);
/**
* Add a new edge.
*
* @param e the edge to add
* @param sourceVertex the source vertex
* @param targetVertex the target vertex
* @return true if the edge was added, false if the edge was already present
*/
boolean add(E e, V sourceVertex, V targetVertex);
/**
* Check if an edge exists
*
* @param e the input edge
* @return true if an edge exists, false otherwise
*/
boolean containsEdge(E e);
/**
* Get the edge set
*
* @return the edge set
*/
Set getEdgeSet();
/**
* Remove an edge.
*
* @param e the edge to remove.
*/
void remove(E e);
/**
* Get the weight of an edge.
*
* @param e the edge
* @return the edge weight
*/
double getEdgeWeight(E e);
/**
* Set the edge weight
*
* @param e the edge
* @param weight the new weight
*/
void setEdgeWeight(E e, double weight);
}