Package model.graph

Record Class UEdge<A>

java.lang.Object
java.lang.Record
model.graph.UEdge<A>
Type Parameters:
A - the type of vertices that form the undirected edge.
public record UEdge<A>(A u, A v) extends Record
A representation of an undirected edge on a simple undirected graph. More formally, an unordered pair of objects of the same type which represent the two vertices that form the ends of an undirected edge. Moreover, the two vertices are not equal as simple undirected graphs do not allow self-loops.

This class models such an undirected edge as a record with two components of the same type <A>, namely u and v, which represent the two vertices that form the ends of an undirected edge.

Note: To ensure undirected / unordered pair behaviour, specifically that new UEdge<>(u, v).equals(new UEdge<>(v, u)) returns true, the end vertices u and v are stored internally in a canonical order. This is done by comparing hashCode() and using toString() as a tiebreaker in case hashCode() is equal for u and v. Therefore, ensure that toString() for objects of type <A> are stable and deterministic.

Since:
2025
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    UEdge(A u, A v)
    Constructs an undirected edge between the vertices u and v both of type <A>.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    toString()
    Returns a string representation of this record class.
    A
    u()
    Returns the value of the u record component.
    A
    v()
    Returns the value of the v record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • UEdge

      public UEdge(A u, A v)
      Constructs an undirected edge between the vertices u and v both of type <A>.
      Parameters:
      u - End vertex of the undirected edge
      v - End vertex of the undirected edge
      Throws:
      exceptions.InvalidEdgeException - if u.equals(v) = true as self-loops are not allowed

  • Method Details

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • u

      public A u()
      Returns the value of the u record component.
      Returns:
      the value of the u record component

    • v

      public A v()
      Returns the value of the v record component.
      Returns:
      the value of the v record component