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

Class DirectLingam

java.lang.Object

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

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable

@Algorithm(name="Direct-LiNGAM",
           command="direct-lingam",
           algoType=forbid_latent_common_causes,
           dataType=Continuous)
@Bootstrapping
public class DirectLingam
extends Object
implements Algorithm, UsesScoreWrapper, ReturnsBootstrapGraphs

Direct LiNGAM.

Author:

bryanandrews

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DirectLingam()
DirectLingam(ScoreWrapper score)

Method Summary

Modifier and Type	Method	Description
List<Graph>	getBootstrapGraphs()
Graph	getComparisonGraph(Graph graph)	Returns that graph that the result should be compared to.
DataType	getDataType()	Returns the data type that the search requires, whether continuous, discrete, or mixed.
String	getDescription()	Returns a short, one-line description of this algorithm.
List<String>	getParameters()	Returns the parameters that this search uses.
ScoreWrapper	getScoreWrapper()
Graph	search(DataModel dataSet, Parameters parameters)	Runs the search.
void	setScoreWrapper(ScoreWrapper score)

Methods inherited from class java.lang.Object

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

Constructor Details

DirectLingam

public DirectLingam()

DirectLingam

public DirectLingam(ScoreWrapper score)

Method Details

search

public Graph search(DataModel dataSet,
 Parameters parameters)

Description copied from interface: Algorithm

Runs the search.

Specified by:

search in interface Algorithm

Parameters:

dataSet - The data set to run to the search on.

parameters - The paramters of the search.

Returns:

The result graph.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Description copied from interface: Algorithm

Returns that graph that the result should be compared to.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

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

Returns:

The comparison graph.

getDescription

public String getDescription()

Description copied from interface: Algorithm

Returns a short, one-line description of this algorithm. This will be printed in the report.

Specified by:

getDescription in interface Algorithm

Returns:

This description.

getDataType

public DataType getDataType()

Description copied from interface: Algorithm

Returns the data type that the search requires, whether continuous, discrete, or mixed.

Specified by:

getDataType in interface Algorithm

Returns:

This type.

getParameters

public List<String> getParameters()

Description copied from interface: Algorithm

Returns the parameters that this search uses.

Specified by:

getParameters in interface Algorithm

Specified by:

getParameters in interface HasParameters

Returns:

A list of String names of parameters.

getBootstrapGraphs

public List<Graph> getBootstrapGraphs()

Specified by:

getBootstrapGraphs in interface ReturnsBootstrapGraphs

getScoreWrapper

public ScoreWrapper getScoreWrapper()

Specified by:

getScoreWrapper in interface UsesScoreWrapper

setScoreWrapper

public void setScoreWrapper(ScoreWrapper score)

Specified by:

setScoreWrapper in interface UsesScoreWrapper