Package edu.cmu.tetrad.search

Record Class CyclicSemScorer.ScoreResult

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.CyclicSemScorer.ScoreResult
Record Components:
bic - The Bayesian Information Criterion score of the evaluated system.
stable - A boolean flag indicating the stability of the evaluated system.
params - The number of parameters used during the evaluation process.
Enclosing class:
CyclicSemScorer
public static record CyclicSemScorer.ScoreResult(double bic, boolean stable, int params) extends Record
Immutable result object representing the computed score from a scoring process.

This record encapsulates three key metrics:

  • BIC (Bayesian Information Criterion): A statistical measure used for model selection.
  • Stability status: Indicates whether the evaluated system is stable or not.
  • Number of parameters: The count of parameters used during the scoring process.

The ScoreResult is typically used to evaluate and compare the quality of models generated or analyzed within a broader scoring framework.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScoreResult(double bic, boolean stable, int params)
    Creates an instance of a ScoreResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    bic()
    Returns the value of the bic 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.
    int
    params()
    Returns the value of the params record component.
    boolean
    stable()
    Returns the value of the stable 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

    • ScoreResult

      public ScoreResult(double bic, boolean stable, int params)
      Creates an instance of a ScoreResult record class.
      Parameters:
      bic - the value for the bic record component
      stable - the value for the stable record component
      params - the value for the params 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.

    • bic

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

    • stable

      public boolean stable()
      Returns the value of the stable record component.
      Returns:
      the value of the stable record component

    • params

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