com.salesforce.jgrapht.DirectedGraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of AptSpringProcessor Show documentation

This project contains the apt processor that implements all the checks enumerated in @Verify. It is a self contained, and shaded jar.

There is a newer version: 2.0.7

Show newest version

/*
 * (C) Copyright 2003-2017, 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 com.salesforce.jgrapht;

import java.util.*;

/**
 * A graph whose all edges are directed. This is the root interface of all directed graphs.
 *
 * 
 * See 
 * http://mathworld.wolfram.com/DirectedGraph.html for more on directed graphs.
 * 
 *
 * @param  the graph vertex type
 * @param  the graph edge type
 *
 * @author Barak Naveh
 * @since Jul 14, 2003
 */
public interface DirectedGraph
    extends Graph
{
    /**
     * Returns the "in degree" of the specified vertex. An in degree of a vertex in a directed graph
     * is the number of inward directed edges from that vertex. See
     * 
     * http://mathworld.wolfram.com/Indegree.html.
     *
     * @param vertex vertex whose degree is to be calculated.
     *
     * @return the degree of the specified vertex.
     */
    int inDegreeOf(V vertex);

    /**
     * Returns a set of all edges incoming into the specified vertex.
     *
     * @param vertex the vertex for which the list of incoming edges to be returned.
     *
     * @return a set of all edges incoming into the specified vertex.
     */
    Set incomingEdgesOf(V vertex);

    /**
     * Returns the "out degree" of the specified vertex. An out degree of a vertex in a directed
     * graph is the number of outward directed edges from that vertex. See
     * 
     * http://mathworld.wolfram.com/Outdegree.html.
     *
     * @param vertex vertex whose degree is to be calculated.
     *
     * @return the degree of the specified vertex.
     */
    int outDegreeOf(V vertex);

    /**
     * Returns a set of all edges outgoing from the specified vertex.
     *
     * @param vertex the vertex for which the list of outgoing edges to be returned.
     *
     * @return a set of all edges outgoing from the specified vertex.
     */
    Set outgoingEdgesOf(V vertex);
}

// End DirectedGraph.java