Package edu.cmu.tetrad.algcomparison.simulation

Class BayesNetSimulation

java.lang.Object
edu.cmu.tetrad.algcomparison.simulation.BayesNetSimulation
All Implemented Interfaces:
Simulation, HasParameters, TetradSerializable, Serializable
public class BayesNetSimulation extends Object implements Simulation
Bayes net simulation.
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

    • BayesNetSimulation

      public BayesNetSimulation(RandomGraph graph)
      Constructs a new BayesNetSimulation.
      Parameters:
      graph - The graph.

    • BayesNetSimulation

      public BayesNetSimulation(BayesPm pm)
      Constructs a new BayesNetSimulation.
      Parameters:
      pm - The Bayes PM.

    • BayesNetSimulation

      public BayesNetSimulation(BayesIm im)
      Constructs a new BayesNetSimulation.
      Parameters:
      im - The Bayes IM.

  • Method Details

    • createData

      public void createData(Parameters parameters, boolean newModel)
      Creates a data set and simulates data.

      Creates the data.

      Specified by:
      createData in interface Simulation
      Parameters:
      parameters - The parameters to use in the simulation.
      newModel - If true, a new model is created. If false, the model is reused.

    • getDataModel

      public DataModel getDataModel(int index)
      Returns the number of data sets to simulate.

      Returns the simulated data set.

      Specified by:
      getDataModel in interface Simulation
      Parameters:
      index - The index of the desired simulated data set.
      Returns:
      That data set.

    • getTrueGraph

      public Graph getTrueGraph(int index)
      Returns the true graph at the given index.

      Returns the true graph.

      Specified by:
      getTrueGraph in interface Simulation
      Parameters:
      index - The index of the desired true graph.
      Returns:
      That graph.

    • getDescription

      public String getDescription()
      Returns the description of the simulation.

      Returns the description.

      Specified by:
      getDescription in interface Simulation
      Returns:
      Returns a one-line description of the simulation, to be printed at the beginning of the report.

    • getShortName

      public String getShortName()
      Returns the short name of the simulation.

      Returns the short name.

      Specified by:
      getShortName in interface Simulation
      Returns:
      The short name of the simulation.

    • getParameters

      public List<String> getParameters()
      Returns the list of parameters used in the simulation.

      Returns the parameters.

      Specified by:
      getParameters in interface HasParameters
      Specified by:
      getParameters in interface Simulation
      Returns:
      Returns the parameters used in the simulation. These are the parameters whose values can be varied.

    • getRandomGraphClass

      public Class<? extends RandomGraph> getRandomGraphClass()
      Description copied from interface: Simulation
      Retrieves the class of a random graph for the simulation.
      Specified by:
      getRandomGraphClass in interface Simulation
      Returns:
      The class of a random graph for the simulation.

    • getSimulationClass

      public Class<? extends Simulation> getSimulationClass()
      Description copied from interface: Simulation
      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.
      Specified by:
      getSimulationClass in interface Simulation
      Returns:
      The class of the simulation.

    • getNumDataModels

      public int getNumDataModels()
      Returns the number of data models.

      Returns the number of data sets.

      Specified by:
      getNumDataModels in interface Simulation
      Returns:
      The number of data sets to simulate.

    • getDataType

      public DataType getDataType()
      Returns the data type of the data.

      Returns the data type.

      Specified by:
      getDataType in interface Simulation
      Returns:
      Returns the type of the data, continuous, discrete or mixed.

    • getBayesIms

      public List<BayesIm> getBayesIms()
      Returns the list of Bayes IMs.
      Returns:
      Ibid.