Package org.ddolib.util

Record Class StateAndDepth<T>

java.lang.Object
java.lang.Record
org.ddolib.util.StateAndDepth<T>
Type Parameters:
T - The type of the state.
Record Components:
state - A state of the solved problem.
depth - The depth of the input state in the main search.
public record StateAndDepth<T>(T state, int depth) extends Record
Class containing a state and its depth in the main search.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StateAndDepth(T state, int depth)
    Creates an instance of a StateAndDepth record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    depth()
    Returns the value of the depth record component.
    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.
    T
    state()
    Returns the value of the state record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StateAndDepth

      public StateAndDepth(T state, int depth)
      Creates an instance of a StateAndDepth record class.
      Parameters:
      state - the value for the state record component
      depth - the value for the depth record component

  • Method Details

    • toString

      public final 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • state

      public T state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • depth

      public int depth()
      Returns the value of the depth record component.
      Returns:
      the value of the depth record component