Record Class PnlAttribution.Result

java.lang.Object
java.lang.Record
com.quantfinlib.risk.PnlAttribution.Result
Enclosing class:
PnlAttribution
public static record PnlAttribution.Result(double spearmanCorrelation, double ksStatistic, PnlAttribution.Zone zone) extends Record
The PLAT verdict for one desk over one window.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Result(double spearmanCorrelation, double ksStatistic, PnlAttribution.Zone zone)
    Creates an instance of a Result record class.

  • 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.
    double
    ksStatistic()
    Returns the value of the ksStatistic record component.
    double
    spearmanCorrelation()
    Returns the value of the spearmanCorrelation record component.
    final String
    toString()
    Returns a string representation of this record class.
    PnlAttribution.Zone
    zone()
    Returns the value of the zone record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Result

      public Result(double spearmanCorrelation, double ksStatistic, PnlAttribution.Zone zone)
      Creates an instance of a Result record class.
      Parameters:
      spearmanCorrelation - the value for the spearmanCorrelation record component
      ksStatistic - the value for the ksStatistic record component
      zone - the value for the zone 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.

    • spearmanCorrelation

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

    • ksStatistic

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

    • zone

      public PnlAttribution.Zone zone()
      Returns the value of the zone record component.
      Returns:
      the value of the zone record component