Package edu.cmu.tetrad.sem

Record Class SemIm.CyclicSimResult

java.lang.Object
java.lang.Record
edu.cmu.tetrad.sem.SemIm.CyclicSimResult
Record Components:
dataSet - The dataset representing the output of the simulation or empirical data used in the simulation.
semIm - The structural equation model implementation capturing the causal structure of the simulation.
Enclosing class:
SemIm
public static record SemIm.CyclicSimResult(DataSet dataSet, SemIm semIm) extends Record
Represents the result of a cyclic simulation. This record combines two main components of the simulation result: a dataset of observed or generated data, and the structural equation model implementation (SEM IM) that describes the underlying causal relationships.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CyclicSimResult(DataSet dataSet, SemIm semIm)
    Creates an instance of a CyclicSimResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    DataSet
    dataSet()
    Returns the value of the dataSet 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.
    SemIm
    semIm()
    Returns the value of the semIm 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

    • CyclicSimResult

      public CyclicSimResult(DataSet dataSet, SemIm semIm)
      Creates an instance of a CyclicSimResult record class.
      Parameters:
      dataSet - the value for the dataSet record component
      semIm - the value for the semIm 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.

    • dataSet

      public DataSet dataSet()
      Returns the value of the dataSet record component.
      Returns:
      the value of the dataSet record component

    • semIm

      public SemIm semIm()
      Returns the value of the semIm record component.
      Returns:
      the value of the semIm record component