Record Class CalendarAnomalies.DayOfWeekProfile

java.lang.Object
java.lang.Record
com.quantfinlib.alpha.CalendarAnomalies.DayOfWeekProfile
Enclosing class:
CalendarAnomalies
public static record CalendarAnomalies.DayOfWeekProfile(double[] meanReturn, double[] tStat, int[] count) extends Record
Per-day-of-week profile, indexed Monday = 0 … Sunday = 6. Days with no observations report NaN mean and t.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DayOfWeekProfile(double[] meanReturn, double[] tStat, int[] count)
    Creates an instance of a DayOfWeekProfile record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    count()
    Returns the value of the count 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.
    double[]
    meanReturn()
    Returns the value of the meanReturn record component.
    final String
    toString()
    Returns a string representation of this record class.
    double[]
    tStat()
    Returns the value of the tStat record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DayOfWeekProfile

      public DayOfWeekProfile(double[] meanReturn, double[] tStat, int[] count)
      Creates an instance of a DayOfWeekProfile record class.
      Parameters:
      meanReturn - the value for the meanReturn record component
      tStat - the value for the tStat record component
      count - the value for the count 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. 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.

    • meanReturn

      public double[] meanReturn()
      Returns the value of the meanReturn record component.
      Returns:
      the value of the meanReturn record component

    • tStat

      public double[] tStat()
      Returns the value of the tStat record component.
      Returns:
      the value of the tStat record component

    • count

      public int[] count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component