Package edu.cmu.tetrad.search.utils

Class R0R4StrategyTestBased

java.lang.Object

edu.cmu.tetrad.search.utils.R0R4StrategyTestBased

All Implemented Interfaces:

R0R4Strategy

public class R0R4StrategyTestBased
extends Object
implements R0R4Strategy

The FciOrientDataExaminationStrategyTestBased class implements the FciOrientDataExaminationStrategy interface and provides methods for checking unshielded colliders and determining orientations based on the Discriminating Path Rule.

This classes uses a test to determine the sepset for two nodes, e and c, which can only be determined by looking at the data.

Author:

jdramsey

See Also:

• R0R4Strategy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	R0R4StrategyTestBased.BlockingType	Enum representing the different types of blocking strategies.

Constructor Summary

Constructors

Constructor	Description
R0R4StrategyTestBased(IndependenceTest test)	Creates a new instance of FciOrientDataExaminationStrategyTestBased.

Method Summary

Modifier and Type	Method	Description
static R0R4Strategy	defaultConfiguration(Graph dag, Knowledge knowledge)	Returns a default configuration of the FciOrientDataExaminationStrategy object.
static R0R4Strategy	defaultConfiguration(IndependenceTest test, Knowledge knowledge)	Returns a default configuration of the FciOrientDataExaminationStrategy object.
org.apache.commons.lang3.tuple.Pair<DiscriminatingPath,Boolean>	doDiscriminatingPathOrientation(DiscriminatingPath discriminatingPath, Graph graph, Set<Node> vNodes)	Does a discriminating path orientation.
Set<Triple>	getAllowedColliders()	The Set of Triples representing the allowed colliders for the FciOrientDataExaminationStrategy.
Set<Triple>	getInitialAllowedColliders()	Retrieves the initial set of allowed colliders.
Knowledge	getknowledge()	Retrieves the Knowledge object used by the FciOrientDataExaminationStrategy.
IndependenceTest	getTest()	Retrieves the IndependenceTest object used by the strategy.
boolean	isUnshieldedCollider(Graph graph, Node i, Node j, Node k)	Checks if a collider is unshielded or not.
void	setAllowedColliders(Set<Triple> allowedColliders)	Sets the allowed colliders for the FciOrientDataExaminationStrategy.
void	setBlockingType(R0R4StrategyTestBased.BlockingType blockingType)	Sets the blocking type for the strategy.
void	setDepth(int depth)	Sets the depth for the FciOrientDataExaminationStrategy object.
void	setEnsureMarkovHelper(EnsureMarkov ensureMarkovHelper)	Sets the EnsureMarkov object used by the R0R4StrategyTestBased.
void	setInitialAllowedColliders(HashSet<Triple> initialAllowedColliders)	Sets the initial set of allowed colliders for the FciOrientDataExaminationStrategy.
void	setKnowledge(Knowledge knowledge)	Sets the knowledge object used by the FciOrientDataExaminationStrategy.
void	setMaxLength(int maxLength)	Sets the maximum length for relevant paths.
void	setPag(Graph pag)	Sets the PAG (partial ancestral graph) for the strategy.
void	setVerbose(boolean verbose)	Sets the verbose mode for the FciOrientDataExaminationStrategy object.
static R0R4Strategy	specialConfiguration(IndependenceTest test, Knowledge knowledge, boolean verbose)	Provides a special configuration for creating an instance of FciOrientDataExaminationStrategy.

Methods inherited from class java.lang.Object

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

Constructor Details

R0R4StrategyTestBased

public R0R4StrategyTestBased(IndependenceTest test)

Creates a new instance of FciOrientDataExaminationStrategyTestBased.

Parameters:

test - the IndependenceTest object used by the strategy

Method Details

specialConfiguration

public static R0R4Strategy specialConfiguration(IndependenceTest test,
 Knowledge knowledge,
 boolean verbose)

Provides a special configuration for creating an instance of FciOrientDataExaminationStrategy.

Parameters:

test - the IndependenceTest object used by the strategy

knowledge - the Knowledge object used by the strategy

verbose - boolean indicating whether to provide verbose output

Returns:

a configured FciOrientDataExaminationStrategy object

Throws:

IllegalArgumentException - if test or knowledge is null

defaultConfiguration

public static R0R4Strategy defaultConfiguration(Graph dag,
 Knowledge knowledge)

Returns a default configuration of the FciOrientDataExaminationStrategy object.

Parameters:

dag - the graph representation

knowledge - the Knowledge object used by the strategy

Returns:

a default configured FciOrientDataExaminationStrategy object

defaultConfiguration

public static R0R4Strategy defaultConfiguration(IndependenceTest test,
 Knowledge knowledge)

Returns a default configuration of the FciOrientDataExaminationStrategy object.

Parameters:

test - the IndependenceTest object used by the strategy

knowledge - the Knowledge object used by the strategy

Returns:

a configured FciOrientDataExaminationStrategy object

Throws:

IllegalArgumentException - if test or knowledge is null

isUnshieldedCollider

public boolean isUnshieldedCollider(Graph graph,
 Node i,
 Node j,
 Node k)

Checks if a collider is unshielded or not.

Specified by:

isUnshieldedCollider in interface R0R4Strategy

Parameters:

graph - the graph containing the nodes

i - the first node of the collider

j - the second node of the collider

k - the third node of the collider

Returns:

true if the collider is unshielded, false otherwise

doDiscriminatingPathOrientation

public org.apache.commons.lang3.tuple.Pair<DiscriminatingPath,Boolean> doDiscriminatingPathOrientation(DiscriminatingPath discriminatingPath,
 Graph graph,
 Set<Node> vNodes)
                                                                                                throws InterruptedException

Does a discriminating path orientation.

Specified by:

doDiscriminatingPathOrientation in interface R0R4Strategy

Parameters:

discriminatingPath - the discriminating path

graph - the graph representation

vNodes - the set of v-nodes

Returns:

The discriminating path is returned as the first element of the pair, and a boolean indicating whether the orientation was done is returned as the second element of the pair.

Throws:

IllegalArgumentException - if 'e' is adjacent to 'c'

InterruptedException

See Also:

• DiscriminatingPath

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets the knowledge object used by the FciOrientDataExaminationStrategy.

Specified by:

setKnowledge in interface R0R4Strategy

Parameters:

knowledge - the knowledge object to be set

getknowledge

public Knowledge getknowledge()

Retrieves the Knowledge object used by the FciOrientDataExaminationStrategy.

Specified by:

getknowledge in interface R0R4Strategy

Returns:

the Knowledge object used by the strategy

setVerbose

public void setVerbose(boolean verbose)

Sets the verbose mode for the FciOrientDataExaminationStrategy object.

Parameters:

verbose - true to enable verbose output, false otherwise

setDepth

public void setDepth(int depth)

Sets the depth for the FciOrientDataExaminationStrategy object.

Parameters:

depth - the depth to be set for the strategy

getTest

public IndependenceTest getTest()

Retrieves the IndependenceTest object used by the strategy.

Returns:

the IndependenceTest object used by the strategy

getInitialAllowedColliders

public Set<Triple> getInitialAllowedColliders()

Retrieves the initial set of allowed colliders.

Specified by:

getInitialAllowedColliders in interface R0R4Strategy

Returns:

The initial set of allowed colliders.

setInitialAllowedColliders

public void setInitialAllowedColliders(HashSet<Triple> initialAllowedColliders)

Sets the initial set of allowed colliders for the FciOrientDataExaminationStrategy.

Specified by:

setInitialAllowedColliders in interface R0R4Strategy

Parameters:

initialAllowedColliders - the HashSet containing the initial allowed colliders

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum length for relevant paths.

Parameters:

maxLength - the maximum length to be set. Set to -1 for no maximum length.

getAllowedColliders

public Set<Triple> getAllowedColliders()

The Set of Triples representing the allowed colliders for the FciOrientDataExaminationStrategy. This variable is initially set to null. Use the setAllowedColliders method to set the allowed colliders. Use the getInitialAllowedColliders method to retrieve the initial set of allowed colliders.

Returns:

The Set of Triples representing the allowed colliders for the FciOrientDataExaminationStrategy.

setAllowedColliders

public void setAllowedColliders(Set<Triple> allowedColliders)

Sets the allowed colliders for the FciOrientDataExaminationStrategy.

Specified by:

setAllowedColliders in interface R0R4Strategy

Parameters:

allowedColliders - the Set of Triples representing allowed colliders

setPag

public void setPag(Graph pag)

Sets the PAG (partial ancestral graph) for the strategy.

Parameters:

pag - the PAG to be set

setEnsureMarkovHelper

public void setEnsureMarkovHelper(EnsureMarkov ensureMarkovHelper)

Sets the EnsureMarkov object used by the R0R4StrategyTestBased.

Parameters:

ensureMarkovHelper - the EnsureMarkov object to be set

setBlockingType

public void setBlockingType(R0R4StrategyTestBased.BlockingType blockingType)

Sets the blocking type for the strategy.

Parameters:

blockingType - the blocking type to be set, which can be either RECURSIVE or GREEDY.