Package edu.cmu.tetrad.search.score

Record Class SemBicScore.LikelihoodResult

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.score.SemBicScore.LikelihoodResult
Record Components:
lik - The computed likelihood value.
dof - The degrees of freedom used in the computation.
penaltyDiscount - The penalty discount applied to the computation.
sampleSize - The size of the sample used in the likelihood computation.
Enclosing class:
SemBicScore
public static record SemBicScore.LikelihoodResult(double lik, int dof, double penaltyDiscount, int sampleSize) extends Record
A record that encapsulates the result of a likelihood computation. This record stores the likelihood value, degrees of freedom, penalty discount, and the sample size associated with the computation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LikelihoodResult(double lik, int dof, double penaltyDiscount, int sampleSize)
    Creates an instance of a LikelihoodResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    dof()
    Returns the value of the dof 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
    lik()
    Returns the value of the lik record component.
    double
    penaltyDiscount()
    Returns the value of the penaltyDiscount record component.
    int
    sampleSize()
    Returns the value of the sampleSize record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LikelihoodResult

      public LikelihoodResult(double lik, int dof, double penaltyDiscount, int sampleSize)
      Creates an instance of a LikelihoodResult record class.
      Parameters:
      lik - the value for the lik record component
      dof - the value for the dof record component
      penaltyDiscount - the value for the penaltyDiscount record component
      sampleSize - the value for the sampleSize 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 '=='.
      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.

    • lik

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

    • dof

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

    • penaltyDiscount

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

    • sampleSize

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