Package edu.cmu.tetrad.algcomparison.simulation

Class LinearFisherModel

java.lang.Object

edu.cmu.tetrad.algcomparison.simulation.LinearFisherModel

All Implemented Interfaces:

Simulation, HasParameters, TakesData, TetradSerializable, Serializable

public class LinearFisherModel
extends Object
implements Simulation, TakesData

Linear Fisher Model.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LinearFisherModel(RandomGraph graph)	Constructor for LinearFisherModel.
LinearFisherModel(RandomGraph graph, List<DataModel> shocks)	Constructor for LinearFisherModel.

Method Summary

Modifier and Type	Method	Description
void	createData(Parameters parameters, boolean newModel)	Creates a data set and simulates data.
DataModel	getDataModel(int index)	Returns the number of data sets to simulate.
DataType	getDataType()	Returns the data type of the data.
String	getDescription()	Returns the description of the simulation.
int	getNumDataModels()	Returns the number of data models.
List<String>	getParameters()	Returns the list of parameters used in the simulation.
Class<? extends RandomGraph>	getRandomGraphClass()	Retrieves the class of a random graph for the simulation.
String	getShortName()	Returns the short name of the simulation.
Class<? extends Simulation>	getSimulationClass()	Returns the class of the simulation.
Graph	getTrueGraph(int index)	Returns the true graph at the given index.

Methods inherited from class java.lang.Object

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

Constructor Details

LinearFisherModel

public LinearFisherModel(RandomGraph graph)

Constructor for LinearFisherModel.

Parameters:

graph - a RandomGraph object

LinearFisherModel

public LinearFisherModel(RandomGraph graph,
 List<DataModel> shocks)

Constructor for LinearFisherModel.

Parameters:

graph - a RandomGraph object

shocks - a List object

Method Details

createData

public void createData(Parameters parameters,
 boolean newModel)

Creates a data set and simulates 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.

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.

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.

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.

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.

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.

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.

Specified by:

getDataType in interface Simulation

Returns:

Returns the type of the data, continuous, discrete or mixed.