Package dev.twilite.game.simulation.rollout

Record Class RolloutResult<S,A>

java.lang.Object
java.lang.Record
dev.twilite.game.simulation.rollout.RolloutResult<S,A>
Type Parameters:
S - simulated state type
A - action type
Record Components:
node - selected search node
public record RolloutResult<S,A>(RolloutNode<S,A> node) extends Record
Best branch selected by a rollout search.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RolloutResult(RolloutNode<S,A> node)
    Creates an instance of a RolloutResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<A>
    actions()
    Returns the full selected action branch.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Optional<A>
    firstAction()
    Returns the first action to execute.
    final int
    hashCode()
    Returns a hash code value for this object.
    RolloutNode<S,A>
    node()
    Returns the value of the node record component.
    double
    score()
    Returns the selected branch's average score.
    S
    state()
    Returns the final state for the selected branch.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RolloutResult

      public RolloutResult(RolloutNode<S,A> node)
      Creates an instance of a RolloutResult record class.
      Parameters:
      node - the value for the node record component

  • Method Details

    • state

      public S state()
      Returns the final state for the selected branch.

    • firstAction

      public Optional<A> firstAction()
      Returns the first action to execute.

    • actions

      public List<A> actions()
      Returns the full selected action branch.

    • score

      public double score()
      Returns the selected branch's average score.

    • 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. 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.

    • node

      public RolloutNode<S,A> node()
      Returns the value of the node record component.
      Returns:
      the value of the node record component