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

Class IsFges

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TetradSerializable, Serializable

@Algorithm(name="IS-FGES",
           command="is-fges",
           algoType=forbid_latent_common_causes)
@Bootstrapping
@Experimental
public class IsFges
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, ReturnsBootstrapGraphs, TakesCovarianceMatrix

IS-FGES (Instance-Specific FGES) wrapper for the algcomparison interface. Uses a discrete instance-specific score (ISBDeuScore) with test=row 0 of train (for now), plus a population BDeu score for the base FGES machinery.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IsFges()	Default constructor for the IsFges class.

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.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.

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

IsFges

public IsFges()

Default constructor for the IsFges class. Initializes an instance of the IsFges algorithm. This algorithm is designed for structure learning in causal discovery frameworks.

Method Details

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: HasParameters

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

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()

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.