Package edu.cmu.tetrad.algcomparison.simulation

Interface Simulation

All Superinterfaces:
HasParameters, Serializable, TetradSerializable
All Known Implementing Classes:
BayesNetSimulation, ConditionalGaussianSimulation, GeneralSemSimulation, GeneralSemSimulationSpecial1, LeeHastieSimulation, LinearFisherModel, LinearSineSimulation, LoadContinuousDataAndGraphs, LoadContinuousDataAndSingleGraph, LoadContinuousDataSmithSim, LoadDataAndGraphs, LoadDataFromFileWithoutGraph, NLSemSimulation, SemSimulation, SemThenDiscretize, StandardizedSemSimulation, TimeSeriesSemSimulation
public interface Simulation extends HasParameters, TetradSerializable
The interface that simulations must implement.
Version:
$Id: $Id
Author:
josephramsey

  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      Constant serialVersionUID=23L
      See Also:

  • Method Details

    • createData

      void createData(Parameters parameters, boolean newModel)
      Creates a data set and simulates data.
      Parameters:
      parameters - The parameters to use in the simulation.
      newModel - If true, a new model is created. If false, the model is reused.

    • getNumDataModels

      int getNumDataModels()
      Returns the number of data models.
      Returns:
      The number of data sets to simulate.

    • getTrueGraph

      Graph getTrueGraph(int index)
      Returns the true graph at the given index.
      Parameters:
      index - The index of the desired true graph.
      Returns:
      That graph.

    • getDataModel

      DataModel getDataModel(int index)
      Returns the number of data sets to simulate.
      Parameters:
      index - The index of the desired simulated data set.
      Returns:
      That data set.

    • getDataType

      DataType getDataType()
      Returns the data type of the data.
      Returns:
      Returns the type of the data, continuous, discrete or mixed.

    • getDescription

      String getDescription()
      Returns the description of the simulation.
      Returns:
      Returns a one-line description of the simulation, to be printed at the beginning of the report.

    • getShortName

      default String getShortName()
      Returns the short name of the simulation.
      Returns:
      The short name of the simulation.

    • getParameters

      List<String> getParameters()
      Returns the list of parameters used in the simulation.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      Returns the parameters used in the simulation. These are the parameters whose values can be varied.

    • getRandomGraphClass

      Class<? extends RandomGraph> getRandomGraphClass()
      Retrieves the class of a random graph for the simulation.
      Returns:
      The class of a random graph for the simulation.

    • getSimulationClass

      Class<? extends Simulation> getSimulationClass()
      Returns the class of the simulation. This method is used to retrieve the class of a simulation based on the selected simulations in the model.
      Returns:
      The class of the simulation.