Package edu.cmu.tetrad.algcomparison.algorithm.continuous.dag

Class IcaLingam

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.continuous.dag.IcaLingam

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TetradSerializable, Serializable

@Algorithm(name="ICA-LiNGAM",
           command="ica-lingam",
           algoType=forbid_latent_common_causes,
           dataType=Continuous)
@Bootstrapping
public class IcaLingam
extends AbstractBootstrapAlgorithm
implements Algorithm, ReturnsBootstrapGraphs

IcaLingam class implements the Algorithm and ReturnsBootstrapGraphs interface. It provides the implementation of the ICA-LiNGAM algorithm for causal discovery.

See Also:

• IcaLingam
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IcaLingam()	Constructs a new instance of the IcaLingam algorithm.

Method Summary

Modifier and Type	Method	Description
Matrix	getBHat()	Retrieves the bHat matrix.
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph based on the true directed graph, if there is one.
DataType	getDataType()	Returns the data type of the given method.
String	getDescription()	Returns the description of the ICA-LiNGAM algorithm.
List<String>	getParameters()	Returns a list of parameters used by the getParameters method.
Graph	runSearch(DataModel dataSet, Parameters parameters)	Searches for a graph structure based on the given data set and parameters.

Methods inherited from class edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

getBootstrapGraphs, search

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.Algorithm

search

Methods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.ReturnsBootstrapGraphs

getBootstrapGraphs

Constructor Details

IcaLingam

public IcaLingam()

Constructs a new instance of the IcaLingam algorithm.

Method Details

runSearch

public Graph runSearch(DataModel dataSet,
 Parameters parameters)

Searches for a graph structure based on the given data set and parameters.

Parameters:

dataSet - The data set to run the search on.

parameters - The parameters of the search.

Returns:

The resulting graph structure.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns a comparison graph based on the true directed graph, if there is one.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

graph - The true, directed graph, if there is one.

Returns:

The comparison graph.

getDescription

public String getDescription()

Returns the description of the ICA-LiNGAM algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

The description of the ICA-LiNGAM algorithm.

getDataType

public DataType getDataType()

Returns the data type of the given method.

Specified by:

getDataType in interface Algorithm

Returns:

The data type of the method. It can be Continuous, Discrete, Mixed, Graph, Covariance, or All.

getParameters

public List<String> getParameters()

Returns a list of parameters used by the getParameters method.

Specified by:

getParameters in interface HasParameters

Returns:

A list of parameters.

getBHat

public Matrix getBHat()

Retrieves the bHat matrix.

Returns:

The bHat matrix.