Package edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag

Class PcLingam

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag.PcLingam

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasKnowledge, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable

@Algorithm(name="PC-LiNGAM",
           command="pc-lingam",
           algoType=forbid_latent_common_causes)
@Bootstrapping
public class PcLingam
extends Object
implements Algorithm, HasKnowledge, UsesScoreWrapper, ReturnsBootstrapGraphs

Peter/Clark algorithm (PC).

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PcLingam()
PcLingam(ScoreWrapper scoreWrapper)

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.
Knowledge	getKnowledge()	Returns a knowledge object.
List<String>	getParameters()	Returns the parameters that this search uses.
ScoreWrapper	getScoreWrapper()
Graph	search(DataModel dataModel, Parameters parameters)	Runs the search.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.
void	setScoreWrapper(ScoreWrapper score)

Methods inherited from class java.lang.Object

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

Constructor Details

PcLingam

public PcLingam()

PcLingam

public PcLingam(ScoreWrapper scoreWrapper)

Method Details

search

public Graph search(DataModel dataModel,
 Parameters parameters)

Description copied from interface: Algorithm

Runs the search.

Specified by:

search in interface Algorithm

Parameters:

dataModel - 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.

getKnowledge

public Knowledge getKnowledge()

Description copied from interface: HasKnowledge

Returns a knowledge object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

a knowledge object.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Description copied from interface: HasKnowledge

Sets a knowledge object.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - a knowledge object.

getScoreWrapper

public ScoreWrapper getScoreWrapper()

Specified by:

getScoreWrapper in interface UsesScoreWrapper

setScoreWrapper

public void setScoreWrapper(ScoreWrapper score)

Specified by:

setScoreWrapper in interface UsesScoreWrapper

getBootstrapGraphs

public List<Graph> getBootstrapGraphs()

Specified by:

getBootstrapGraphs in interface ReturnsBootstrapGraphs