Module org.jgrapht.core
Package org.jgrapht.generate.netgen

Class NetworkInfo<V,​E>

  • Type Parameters:
    V - the graph vertex type
    E - the graph edge type
    public class NetworkInfo<V,​E>
extends java.lang.Object
    Represents network auxiliary information. This information is produced by the NetworkGenerator.

    Using the network information instance, you can find out:

    • Which network vertices belong to which class.
    • Which network arcs belong to the skeleton network.
    See Also:
    NetworkGenerator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) NetworkGeneratorConfig config
      Network configuration.
      (package private) java.util.List<E> skeletonArcs
      List of network skeleton arcs.
      (package private) java.util.List<V> vertices
      List of network vertices.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<V> getPureSinks()
      Returns a list containing network pure sinks.
      java.util.List<V> getPureSources()
      Returns a list containing network pure sources.
      java.util.List<V> getSinks()
      Returns a list containing network sinks (pure sinks + t-sinks).
      java.util.List<E> getSkeletonArcs()
      Return a list of network skeleton arcs.
      java.util.List<V> getSources()
      Returns a list containing network sources (pure sources + t-sources).
      java.util.List<V> getTransshipmentNodes()
      Returns a list containing network t-nodes.
      java.util.List<V> getTransshipmentSinks()
      Return a list containing network t-sinks.
      java.util.List<V> getTransshipmentSources()
      Returns a list containing network t-sources.
      (package private) void registerChainArc​(E chainArc)
      Saves information about the arc chainArc.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • vertices

        java.util.List<V> vertices
        List of network vertices.

      • skeletonArcs

        java.util.List<E> skeletonArcs
        List of network skeleton arcs.

    • Constructor Detail

      • NetworkInfo

        NetworkInfo​(NetworkGeneratorConfig config)
        Creates a new network information instance.
        Parameters:
        config - network configuration.

    • Method Detail

      • registerChainArc

        void registerChainArc​(E chainArc)
        Saves information about the arc chainArc.
        Parameters:
        chainArc - chain arc.

      • getPureSources

        public java.util.List<V> getPureSources()
        Returns a list containing network pure sources.
        Returns:
        a list containing network pure sources.

      • getTransshipmentSources

        public java.util.List<V> getTransshipmentSources()
        Returns a list containing network t-sources.
        Returns:
        a list containing network t-sources.

      • getSources

        public java.util.List<V> getSources()
        Returns a list containing network sources (pure sources + t-sources).
        Returns:
        a list containing network sources.

      • getTransshipmentNodes

        public java.util.List<V> getTransshipmentNodes()
        Returns a list containing network t-nodes.
        Returns:
        a list containing network t-nodes.

      • getPureSinks

        public java.util.List<V> getPureSinks()
        Returns a list containing network pure sinks.
        Returns:
        a list containing network pure sinks.

      • getTransshipmentSinks

        public java.util.List<V> getTransshipmentSinks()
        Return a list containing network t-sinks.
        Returns:
        a list containing network t-sinks.

      • getSinks

        public java.util.List<V> getSinks()
        Returns a list containing network sinks (pure sinks + t-sinks).
        Returns:
        a list containing network sinks.

      • getSkeletonArcs

        public java.util.List<E> getSkeletonArcs()
        Return a list of network skeleton arcs.
        Returns:
        a list of network skeleton arcs.