Enum EdgeOrientation

java.lang.Object
java.lang.Enum<EdgeOrientation>
es.uam.eps.ir.relison.graph.edges.EdgeOrientation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EdgeOrientation>, java.lang.constant.Constable

public enum EdgeOrientation
extends java.lang.Enum<EdgeOrientation>
Indicates the orientation of the edges to take.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    IN
    Orientation for selecting the incoming neighborhood (incident nodes).
    MUTUAL
    Orientation for selecting neighbors which are both adjacent and incident.
    OUT
    Orientation for selecting the outgoing neighborhood (adjacent nodes).
    UND
    Orientation for selecting the undirected neighbor (both adjacent and incident nodes).
  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    private EdgeOrientation()  
  • Method Summary

    Modifier and Type Method Description
    EdgeOrientation complementarySelection()
    Selection for the complementary graph.
    EdgeOrientation invertSelection()
    Given an edge orientation, returns the opposite orientation.
    static EdgeOrientation valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static EdgeOrientation[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • OUT

      public static final EdgeOrientation OUT
      Orientation for selecting the outgoing neighborhood (adjacent nodes).
    • IN

      public static final EdgeOrientation IN
      Orientation for selecting the incoming neighborhood (incident nodes).
    • UND

      public static final EdgeOrientation UND
      Orientation for selecting the undirected neighbor (both adjacent and incident nodes).
    • MUTUAL

      public static final EdgeOrientation MUTUAL
      Orientation for selecting neighbors which are both adjacent and incident.
  • Constructor Details

  • Method Details

    • values

      public static EdgeOrientation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static EdgeOrientation valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • invertSelection

      public EdgeOrientation invertSelection()
      Given an edge orientation, returns the opposite orientation.
      Returns:
      the opposite orientation.
    • complementarySelection

      public EdgeOrientation complementarySelection()
      Selection for the complementary graph.
      Returns:
      the selection for the complementary graph.