Record Class CrbRouter.DarkVenue

java.lang.Object
java.lang.Record
com.quantfinlib.crb.CrbRouter.DarkVenue
Enclosing class:
CrbRouter
public static record CrbRouter.DarkVenue(String name, double expectedLiquidity, double fillProbability, double adverseSelectionBps) extends Record
A dark venue as the router sees it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DarkVenue(String name, double expectedLiquidity, double fillProbability, double adverseSelectionBps)
    Creates an instance of a DarkVenue record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    adverseSelectionBps()
    Returns the value of the adverseSelectionBps record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    expectedLiquidity()
    Returns the value of the expectedLiquidity record component.
    double
    fillProbability()
    Returns the value of the fillProbability record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name 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

    • DarkVenue

      public DarkVenue(String name, double expectedLiquidity, double fillProbability, double adverseSelectionBps)
      Creates an instance of a DarkVenue record class.
      Parameters:
      name - the value for the name record component
      expectedLiquidity - the value for the expectedLiquidity record component
      fillProbability - the value for the fillProbability record component
      adverseSelectionBps - the value for the adverseSelectionBps 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • expectedLiquidity

      public double expectedLiquidity()
      Returns the value of the expectedLiquidity record component.
      Returns:
      the value of the expectedLiquidity record component

    • fillProbability

      public double fillProbability()
      Returns the value of the fillProbability record component.
      Returns:
      the value of the fillProbability record component

    • adverseSelectionBps

      public double adverseSelectionBps()
      Returns the value of the adverseSelectionBps record component.
      Returns:
      the value of the adverseSelectionBps record component