Package edu.cmu.tetrad.search.work_in_progress

Class VcPcFast

java.lang.Object

edu.cmu.tetrad.search.work_in_progress.VcPcFast

All Implemented Interfaces:

IGraphSearch

public final class VcPcFast
extends Object
implements IGraphSearch

Implements a convervative version of PC, in which the Markov condition is assumed but faithfulness is tested locally.

Version:

$Id: $Id

Author:

josephramsey (this version).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VcPcFast.CpcTripleType	An enum of the types of triples that can be found in a graph.

Constructor Summary

Constructors

Constructor	Description
VcPcFast(IndependenceTest independenceTest)	Constructs a CPC algorithm that uses the given independence test as oracle.

Method Summary

Modifier and Type	Method	Description
static void	futureNodeVisit(Graph graph, Node b, LinkedList<Node> path, Set<Node> futureNodes)	futureNodeVisit.
Set<Edge>	getAdjacencies()	getAdjacencies.
Set<Triple>	getAmbiguousTriples()	Getter for the field ambiguousTriples.
Set<Edge>	getApparentNonadjacencies()	getApparentNonadjacencies.
Set<Triple>	getColliderTriples()	Getter for the field colliderTriples.
Set<Edge>	getDefiniteNonadjacencies()	getDefiniteNonadjacencies.
int	getDepth()	Getter for the field depth.
long	getElapsedTime()	Getter for the field elapsedTime.
Graph	getGraph()	The graph that's constructed during the search.
IndependenceTest	getIndependenceTest()	Getter for the field independenceTest.
Knowledge	getKnowledge()	Getter for the field knowledge.
Set<Triple>	getNoncolliderTriples()	Getter for the field noncolliderTriples.
VcPcFast.CpcTripleType	getPopulationTripleType(Node x, Node y, Node z, IndependenceTest test, int depth, Graph graph, boolean verbose)	getPopulationTripleType.
boolean	isMeekPreventCycles()	isMeekPreventCycles.
Graph	search()	search.
void	setDepth(int depth)	Sets the maximum number of variables conditioned on in any conditional independence test.
void	setFacts(IndependenceFacts facts)	Setter for the field facts.
void	setGraph(Graph graph)	Setter for the field graph.
void	setKnowledge(Knowledge knowledge)	Sets the knowledge specification used in the search.
void	setMeekPreventCycles(boolean meekPreventCycles)	Sets to true just in case edges will not be added if they would create cycles.
void	setVerbose(boolean verbose)	Setter for the field verbose.

Methods inherited from class java.lang.Object

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

Constructor Details

VcPcFast

public VcPcFast(IndependenceTest independenceTest)

Constructs a CPC algorithm that uses the given independence test as oracle. This does not make a copy of the independence test, for fear of duplicating the data set!

Parameters:

independenceTest - a IndependenceTest object

Method Details

futureNodeVisit

public static void futureNodeVisit(Graph graph,
 Node b,
 LinkedList<Node> path,
 Set<Node> futureNodes)

futureNodeVisit.

Parameters:

graph - a Graph object

b - a Node object

path - a LinkedList object

futureNodes - a Set object

isMeekPreventCycles

public boolean isMeekPreventCycles()

isMeekPreventCycles.

Returns:

true just in case edges will not be added if they would create cycles.

setMeekPreventCycles

public void setMeekPreventCycles(boolean meekPreventCycles)

Sets to true just in case edges will not be added if they would create cycles.

Parameters:

meekPreventCycles - a boolean

getElapsedTime

public long getElapsedTime()

Getter for the field elapsedTime.

Returns:

the elapsed time of search in milliseconds, after search() has been run.

getKnowledge

public Knowledge getKnowledge()

Getter for the field knowledge.

Returns:

the knowledge specification used in the search. Non-null.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets the knowledge specification used in the search. Non-null.

Parameters:

knowledge - a Knowledge object

getIndependenceTest

public IndependenceTest getIndependenceTest()

Getter for the field independenceTest.

Returns:

the independence test used in the search, set in the constructor. This is not returning a copy, for fear of duplicating the data set!

getDepth

public int getDepth()

Getter for the field depth.

Returns:

the depth of the search--that is, the maximum number of variables conditioned on in any conditional independence test.

setDepth

public void setDepth(int depth)

Sets the maximum number of variables conditioned on in any conditional independence test. If set to -1, the value of 1000 will be used. May not be set to Integer.MAX_VALUE, due to a Java bug on multi-core systems.

Parameters:

depth - a int

getAmbiguousTriples

public Set<Triple> getAmbiguousTriples()

Getter for the field ambiguousTriples.

Returns:

the set of ambiguous triples found during the most recent run of the algorithm. Non-null after a call to search().

getColliderTriples

public Set<Triple> getColliderTriples()

Getter for the field colliderTriples.

Returns:

the set of collider triples found during the most recent run of the algorithm. Non-null after a call to search().

getNoncolliderTriples

public Set<Triple> getNoncolliderTriples()

Getter for the field noncolliderTriples.

Returns:

the set of noncollider triples found during the most recent run of the algorithm. Non-null after a call to search().

getAdjacencies

public Set<Edge> getAdjacencies()

getAdjacencies.

Returns:

a Set object

getApparentNonadjacencies

public Set<Edge> getApparentNonadjacencies()

getApparentNonadjacencies.

Returns:

a Set object

getDefiniteNonadjacencies

public Set<Edge> getDefiniteNonadjacencies()

getDefiniteNonadjacencies.

Returns:

a Set object

search

public Graph search()
             throws InterruptedException

search.

Specified by:

search in interface IGraphSearch

Returns:

a Graph object

Throws:

InterruptedException - if any.

getPopulationTripleType

public VcPcFast.CpcTripleType getPopulationTripleType(Node x,
 Node y,
 Node z,
 IndependenceTest test,
 int depth,
 Graph graph,
 boolean verbose)
                                               throws InterruptedException

getPopulationTripleType.

Parameters:

x - a Node object

y - a Node object

z - a Node object

test - a IndependenceTest object

depth - a int

graph - a Graph object

verbose - a boolean

Returns:

a VcPcFast.CpcTripleType object

Throws:

InterruptedException

getGraph

public Graph getGraph()

The graph that's constructed during the search.

Returns:

a Graph object

setGraph

public void setGraph(Graph graph)

Setter for the field graph.

Parameters:

graph - a Graph object

setVerbose

public void setVerbose(boolean verbose)

Setter for the field verbose.

Parameters:

verbose - a boolean

setFacts

public void setFacts(IndependenceFacts facts)

Setter for the field facts.

Parameters:

facts - a IndependenceFacts object