Class TrainedDagSimulatorANM.SimResult

java.lang.Object
edu.cmu.tetrad.sem.TrainedDagSimulatorANM.SimResult
Enclosing class:
TrainedDagSimulatorANM
public static final class TrainedDagSimulatorANM.SimResult extends Object
Represents the result of a simulation, encapsulating the simulation data, variables, the true Directed Acyclic Graph (DAG), and optional diagnostic information. The class contains both continuous and discrete data matrices, as well as information about any warnings or thresholds exceeded during the simulation process. It also provides a method to generate a formatted report summarizing the results.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final double[][]
    cont
    A container for simulation results, including continuous and discrete values, variables, and true DAG.
    final int[][]
    disc
    A 2D array representing the discrete codes for all variables in the simulation.
    final long
    nSamples
    Represents the total number of samples generated during a simulation.
    final Graph
    trueDag
    Represents the true Directed Acyclic Graph (DAG) associated with the simulation results.
    final List<Node>
    variables
    A list of variables involved in the simulation, including both continuous and discrete variables.
    final long[]
    zExceedWarn1
    Array storing the count of exceedance warnings for each variable index during simulations.
    final long[]
    zExceedWarn2
    Array storing the count of exceedance warnings for each variable index during simulations.
    final double
    zWarn1
    Array storing the count of exceedance warnings for each variable index during simulations.
    final double
    zWarn2
    Array storing the count of exceedance warnings for each variable index during simulations.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSimReportText(double lambdaParents, boolean bootstrapRoots)
    Generates a simulation report summarizing the results of a TrainedDagSimulator.

    Methods inherited from class Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • cont

      public final double[][] cont
      A container for simulation results, including continuous and discrete values, variables, and true DAG.

    • disc

      public final int[][] disc
      A 2D array representing the discrete codes for all variables in the simulation. Each element in the array corresponds to the discrete encoding for a specific variable. Continuous variables are represented with a value of 0 in their respective columns. This array is used to store the categorical or discrete values relevant for the simulation.

    • variables

      public final List<Node> variables
      A list of variables involved in the simulation, including both continuous and discrete variables.

    • trueDag

      public final Graph trueDag
      Represents the true Directed Acyclic Graph (DAG) associated with the simulation results. This graph encodes the underlying causal structure presumed to generate the data. It is typically used for validation purposes or to compare to the inferred structure.

    • nSamples

      public final long nSamples
      Represents the total number of samples generated during a simulation. This value is fundamental to interpreting the results of the simulation, as it determines the dataset size used for computational procedures.

      It is typically used to assess the scale of the simulation and may influence statistical measures computed from the results.

    • zExceedWarn1

      public final long[] zExceedWarn1
      Array storing the count of exceedance warnings for each variable index during simulations. These warnings are triggered whenever certain thresholds or conditions are surpassed for the respective variables, which may indicate potential issues or anomalies in the simulation process.

    • zExceedWarn2

      public final long[] zExceedWarn2
      Array storing the count of exceedance warnings for each variable index during simulations. These warnings are triggered whenever certain thresholds or conditions are surpassed for the respective variables, which may indicate potential issues or anomalies in the simulation process.

    • zWarn1

      public final double zWarn1
      Array storing the count of exceedance warnings for each variable index during simulations. These warnings are triggered whenever certain thresholds or conditions are surpassed for the respective variables, which may indicate potential issues or anomalies in the simulation process. This array is used to track the number of times a variable's value exceeds a certain threshold during simulations.

    • zWarn2

      public final double zWarn2
      Array storing the count of exceedance warnings for each variable index during simulations. These warnings are triggered whenever certain thresholds or conditions are surpassed for the respective variables, which may indicate potential issues or anomalies in the simulation process. This array is used to track the number of times a variable's value exceeds a certain threshold during simulations.

  • Method Details

    • getSimReportText

      public String getSimReportText(double lambdaParents, boolean bootstrapRoots)
      Generates a simulation report summarizing the results of a TrainedDagSimulator. The report includes details about the simulation parameters, warnings, and other relevant information.
      Parameters:
      lambdaParents - The regularization parameter controlling the strength of parent relationships in the simulation.
      bootstrapRoots - A boolean indicating whether roots were bootstrapped in the simulation.
      Returns:
      A string containing the formatted simulation report.