net.automatalib.graphs.BidirectionalGraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of automata-api Show documentation

This artifact contains the API of AutomataLib, which mainly consists of interfaces for the various concepts and automaton models supported by the AutomataLib core. In addition to that, it also defines some fundamental classes for dealing with words of symbols.

There is a newer version: 0.11.0

Show newest version

/* Copyright (C) 2013 TU Dortmund
 * This file is part of AutomataLib, http://www.automatalib.net/.
 * 
 * AutomataLib is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 3.0 as published by the Free Software Foundation.
 * 
 * AutomataLib 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 AutomataLib; if not, see
 * http://www.gnu.de/documents/lgpl.en.html.
 */
package net.automatalib.graphs;

import java.util.Collection;

/**
 * Interface for bidirectional graph. A bidirectional graph is conceptually the same as
 * a normal (directed) graph, but provides direct access to not only the outgoing, but also
 * the incoming edges of each state.
 * 
 * @author Malte Isberner 
 *
 * @param  node class
 * @param  edge class
 */
public interface BidirectionalGraph extends Graph {
	/**
	 * Retrieves the incoming edges of a given node.
	 * @param node the node
	 * @return all incoming edges of the specified node.
	 */
	public Collection getIncomingEdges(N node);
	
	/**
	 * Retrieves the source node of a given edge.
	 * @param edge the edge
	 * @return the source node of the given edge
	 */
	public N getSource(E edge);
}