Record Class AdaptiveSor.RoutingDecision

java.lang.Object
java.lang.Record
com.quantfinlib.execution.AdaptiveSor.RoutingDecision
Enclosing class:
AdaptiveSor
public static record AdaptiveSor.RoutingDecision(List<SmartOrderRouter.RouteLeg> lit, List<SmartOrderRouter.RouteLeg> probes, long routedQty, long unrouted) extends Record
The routed plan: lit legs cover up to the requested quantity (best-expected-cost first); probes are additive contingent dark legs sent alongside; unrouted is the shortfall no eligible lit venue could absorb (0 on a fully routed order).

  • Constructor Details

    • RoutingDecision

      public RoutingDecision(List<SmartOrderRouter.RouteLeg> lit, List<SmartOrderRouter.RouteLeg> probes, long routedQty, long unrouted)
      Creates an instance of a RoutingDecision record class.
      Parameters:
      lit - the value for the lit record component
      probes - the value for the probes record component
      routedQty - the value for the routedQty record component
      unrouted - the value for the unrouted 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 the compare method from their corresponding wrapper classes.
      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.

    • lit

      public List<SmartOrderRouter.RouteLeg> lit()
      Returns the value of the lit record component.
      Returns:
      the value of the lit record component

    • probes

      public List<SmartOrderRouter.RouteLeg> probes()
      Returns the value of the probes record component.
      Returns:
      the value of the probes record component

    • routedQty

      public long routedQty()
      Returns the value of the routedQty record component.
      Returns:
      the value of the routedQty record component

    • unrouted

      public long unrouted()
      Returns the value of the unrouted record component.
      Returns:
      the value of the unrouted record component