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

Class BossLingam

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

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

@Algorithm(name="BOSS-LiNGAM",
           command="boss-lingam",
           algoType=forbid_latent_common_causes)
@Bootstrapping
public class BossLingam
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, UsesScoreWrapper, ReturnsBootstrapGraphs

BOSS-LiNGAM algorithm. This runs the BOSS algorithm to find the CPDAG and then orients the undirected edges using the LiNGAM algorithm.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BossLingam()	Constructs a new BOSS-LiNGAM algorithm.
BossLingam(ScoreWrapper scoreWrapper)	Constructs a new BOSS-LiNGAM algorithm with the given score.

Method Summary

Modifier and Type	Method	Description
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 list of parameter names that are used.
ScoreWrapper	getScoreWrapper()	Returns the score wrapper.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.
void	setScoreWrapper(ScoreWrapper score)	Sets the score wrapper.

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

BossLingam

public BossLingam()

Constructs a new BOSS-LiNGAM algorithm.

BossLingam

public BossLingam(ScoreWrapper scoreWrapper)

Constructs a new BOSS-LiNGAM algorithm with the given score.

Parameters:

scoreWrapper - the score to use

Method Details

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns that graph that the result should be compared to.

Returns the comparison 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()

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

Returns the description of the algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

This description.

getDataType

public DataType getDataType()

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

Returns the data type that the algorithm can handle.

Specified by:

getDataType in interface Algorithm

Returns:

This type.

getParameters

public List<String> getParameters()

Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not

Returns the parameters for the algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not already defined they'll need to be defined there.

getKnowledge

public Knowledge getKnowledge()

Returns a knowledge object.

Returns the knowledge.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

a knowledge object.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets a knowledge object.

Sets the knowledge.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - a knowledge object.

getScoreWrapper

public ScoreWrapper getScoreWrapper()

Returns the score wrapper.

Returns the score wrapper.

Specified by:

getScoreWrapper in interface UsesScoreWrapper

Returns:

the score wrapper.

setScoreWrapper

public void setScoreWrapper(ScoreWrapper score)

Sets the score wrapper.

Sets the score wrapper.

Specified by:

setScoreWrapper in interface UsesScoreWrapper

Parameters:

score - the score wrapper.