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

Class IcaLingD

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TetradSerializable, Serializable

@Algorithm(name="ICA-LiNG-D",
           command="ica-ling-d",
           algoType=forbid_latent_common_causes,
           dataType=Continuous)
@Bootstrapping
public class IcaLingD
extends AbstractBootstrapAlgorithm
implements Algorithm, ReturnsBootstrapGraphs

IcaLingD is an implementation of the Algorithm interface that performs the ICA-LiNG-D algorithm for discovering causal models for the linear non-Gaussian case where the underlying model might be cyclic.

See Also:

• IcaLingD
• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Retrieves the comparison graph of the provided true directed graph.
DataType	getDataType()	Retrieves the data type of the algorithm.
String	getDescription()	Retrieves the description of the algorithm.
List<String>	getParameters()	Retrieves the list of parameters used by this method.
List<Matrix>	getStableBHats()	Retrieves the list of stable B matrices generated by the algorithm.
List<Graph>	getStableGraphs()	Retrieves the list of stable graphs generated by the algorithm.
List<Matrix>	getUnstableBHats()	Retrieves the list of unstable B matrices generated by the algorithm.
List<Graph>	getUnstableGraphs()	Retrieves the list of unstable graphs generated by the algorithm.
Graph	runSearch(DataModel dataSet, Parameters parameters)	Runs a search on the provided data set using the given 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

IcaLingD

public IcaLingD()

Constructs a new instance of the IcaLingD algorithm.

Method Details

runSearch

public Graph runSearch(DataModel dataSet,
 Parameters parameters)

Runs a search on the provided data set using the given parameters. If verbose is set to true, all stable and unstable graphs are printed to the console along with their B matrices.

Parameters:

dataSet - The data set to run the search on.

parameters - The parameters of the search.

Returns:

One of the stable graphs, otherwise and empty graph.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Retrieves the comparison graph of the provided true directed graph.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

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

Returns:

The comparison graph.

getDescription

public String getDescription()

Retrieves the description of the algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

The description of the algorithm.

getDataType

public DataType getDataType()

Retrieves the data type of the algorithm.

Specified by:

getDataType in interface Algorithm

Returns:

The data type of the algorithm.

getParameters

public List<String> getParameters()

Retrieves the list of parameters used by this method.

Specified by:

getParameters in interface HasParameters

Returns:

A list of strings representing the parameters used by this method.

getStableGraphs

public List<Graph> getStableGraphs()

Retrieves the list of stable graphs generated by the algorithm.

Returns:

A list of stable graphs.

getUnstableGraphs

public List<Graph> getUnstableGraphs()

Retrieves the list of unstable graphs generated by the algorithm.

Returns:

A list of unstable graphs.

getStableBHats

public List<Matrix> getStableBHats()

Retrieves the list of stable B matrices generated by the algorithm.

Returns:

A list of stable B matrices.

getUnstableBHats

public List<Matrix> getUnstableBHats()

Retrieves the list of unstable B matrices generated by the algorithm.

Returns:

A list of unstable B matrices.