Record Class MonteCarloSimulator.Estimate

java.lang.Object
java.lang.Record
com.quantfinlib.simulation.MonteCarloSimulator.Estimate
Enclosing class:
MonteCarloSimulator
public static record MonteCarloSimulator.Estimate(double mean, double standardError, int samples) extends Record
Monte Carlo estimate: mean, its standard error, and the number of independent samples.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Estimate(double mean, double standardError, int samples)
    Creates an instance of a Estimate 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
    mean()
    Returns the value of the mean record component.
    int
    samples()
    Returns the value of the samples record component.
    double
    standardError()
    Returns the value of the standardError record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Estimate

      public Estimate(double mean, double standardError, int samples)
      Creates an instance of a Estimate record class.
      Parameters:
      mean - the value for the mean record component
      standardError - the value for the standardError record component
      samples - the value for the samples 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 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.

    • mean

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

    • standardError

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

    • samples

      public int samples()
      Returns the value of the samples record component.
      Returns:
      the value of the samples record component