Class Paths
- All Implemented Interfaces:
TetradSerializable,Serializable
Paths class.
- Version:
- $Id: $Id
- Author:
- josephramsey
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn algorithm to find all cliques in a graph. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadjustmentSets(Node source, Node target, int maxNumSets, int maxDistanceFromEndpoint, int nearWhichEndpoint, int maxPathLength) An adjustment set for a pair of nodes <source, target> for a CPDAG is a set of nodes that blocks all paths from the source to the target that cannot contribute to a calculation for the total effect of the source on the target in any DAG in a CPDAG while not blocking any path from the source to the target that could be causal.allDirectedPaths(Node node1, Node node2, int maxLength) Finds all directed paths from node1 to node2 with a maximum length.Finds all paths from node1 to node2 within a specified maximum length.allPaths(Node node1, Node node2, int minLength, int maxLength, Set<Node> conditionSet, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Finds all paths between two nodes satisfying certain conditions.Finds all paths between two nodes within a given maximum length, considering optional condition set and selection bias.allPathsOutOf(Node node1, int maxLength, Set<Node> conditionSet, boolean allowSelectionBias) Generates all paths out of a given node within a specified maximum length and conditional set.amenablePathsMpdagMag(Node node1, Node node2, int maxLength) Finds amenable paths from the given source node to the given destination node with a maximum length.amenablePathsPag(Node node1, Node node2, int maxLength) Finds amenable paths from the given source node to the given destination node with a maximum length, for a PAG.anteriority(Node... X) Returns the set of nodes that are in the anteriority of the given nodes in the graph.Returns a list of connected components in the graph.booleandefiniteNonDescendent(Node node1, Node node2) added by ekorber, 2004/06/12booleandefVisiblePag(Node A, Node B) Returns true if the edge form A to B is a definitely visible edge in a PAG.directedPaths(Node node1, Node node2, int maxLength) Finds all directed paths from node1 to node2 with a maximum length.Retrieves the set of nodes that belong to the same district as the given node.Returns D-SEP(x, y) for a maximal ancestral graph G (or inducing path graph G, as in Causation, Prediction and Search).booleanexistsDirectedCycle.booleanexistsDirectedPath(Node node1, Node node2) Checks if a directed path exists between two nodes in a graph.booleanexistsDirectedPath(Node node1, Node node2, int depth) Checks if a directed path exists between two nodes within a certain depth.booleanexistsDirectedPath(Node node1, Node node2, org.apache.commons.lang3.tuple.Pair<Node, Node> without) Checks if a directed path exists between two nodes in a graph, ignoring a specified edge.booleanexistsInducingPath(Node x, Node y, Set<Node> selectionVariables) Determines whether an inducing path exists between two nodes in a graph.booleanexistsInducingPathBFS(Node x, Node y, Set<Node> selectionVariables) Breadth-first version of the âinducing-path exists?â test.booleanexistsInducingPathDFS(Node x, Node y, Set<Node> selectionVariables) Determines whether an inducing path exists between node1 and node2, given a set O of observed nodes and a set sem of conditioned nodes.booleanexistsInducingPathVisit(Node a, Node b, Node x, Node y, Set<Node> selectionVariables, LinkedList<Node> path) Determines whether an inducing path exists between two nodes in a graph.booleanexistsSemiDirectedPath(Node from, Node to) existsSemiDirectedPath.booleanexistsSemiDirectedPath(Node node1, Set<Node> nodes) existsSemiDirectedPath.booleanexistsTrek(Node node1, Node node2) Determines whether a trek exists between two nodes in the graph.getAncestors(Node node) Retrieves the ancestors of a specified `Node` in the graph.getAncestors(List<Node> nodes) Returns a list of all ancestors of the given nodes.Return a map from each node to its collection of ancestors.static GraphGenerates a directed acyclic graph (DAG) based on the given list of nodes using Raskutti and Uhler's method.getDescendants(Node node) Returns a list of all descendants of the given node.getDescendants(List<Node> nodes) Retrieves the descendants of the given list of nodes.Return a map from each node to its collection of descendants.getInducingPath(Node x, Node y, Set<Node> selectionVariables) This method calculates the inducing path between two measured nodes in a graph.getMConnectedVars(Node y, Set<Node> z) Retrieves the set of nodes that are connected to the given nodeyand are also present in the set of nodesz.getMConnectedVars.getParents(List<Node> pi, int p, Graph g, boolean verbose, boolean allowSelectionBias) Returns the parents of the node at index p, calculated using Pearl's method.getSepset(Node x, Node y, boolean allowSelectionBias, IndependenceTest test, int depth) Finds a sepset for x and y, if there is one; otherwise, returns null.getSepsetContaining(Node x, Node y, Set<Node> containing, int maxPathLength) Retrieves a sepset (a set of nodes) between two given nodes.getValidOrder(List<Node> initialOrder, boolean forward) Returns a valid causal order for either a DAG or a CPDAG.getValidOrderMag(List<Node> initialOrder, boolean forward) Generates a valid topological ordering of nodes in a directed graph without cycles.booleanDetermines whether the graph is acyclic, meaning it does not contain any directed cycles.booleanisAncestorOf(Node node1, Node node2) Determines whether one node is an ancestor of another.booleanisAncestorOfAnyZ(Node b, Set<Node> z) Return true if b is an ancestor of any node in zbooleanisDescendentOf(Node node1, Node node2) Determines whether one node is a descendent of another.booleanisDirected(Node node1, Node node2) Checks if there is a directed edge from node1 to node2 in the graph.booleanChecks if the current graph is a legal CPDAG (completed partially directed acyclic graph).booleanChecks if the graph passed as parameter is a legal directed acyclic graph (DAG).booleanChecks if the given graph is a legal mag.booleanChecks if the given Maximal Ancestral Graph (MAG) is legal.booleanChecks if the given graph is a legal Maximal Partial Directed Acyclic Graph (MPDAG).booleanChecks if the given Directed Acyclic Graph (DAG) is a Legal Partial Ancestral Graph (PAG).booleanDetermines if the current graph configuration is maximal.booleanisMConnectedTo(Node x, Node y, Set<Node> z, boolean allowSelectionBias) Determmines whether x and y are d-connected given z.booleanDetemrmines whether x and y are d-connected given z.booleanisMConnectingPath(List<Node> path, Set<Node> conditioningSet, boolean isPag) Checks if the given path is an m-connecting path.booleanisMConnectingPath(List<Node> path, Set<Node> conditioningSet, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Checks if the given path is an m-connecting path and doens't contain duplicate nodes.booleanisMSeparatedFrom(Node node1, Node node2, Set<Node> z, boolean isPag) Determines whether one n ode is d-separated from another.booleanisMSeparatedFrom(Node node1, Node node2, Set<Node> z, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Checks if two nodes are M-separated.booleanCheck to see if a set of variables Z satisfies the back-door criterion relative to node x and node y.booleanisUndirected(Node node1, Node node2) Checks if the edge between two nodes in the graph is undirected.voidmakeValidOrder(List<Node> order) Reorders the given order into a valid causal order for either a DAG or a CPDAG.markovBlanket(Node node) Returns the Markov Blanket of a given node in the graph.Returns a set of all maximum cliques in the graph.booleanpossibleAncestor(Node node1, Node node2) possibleAncestor.possibleDsep(Node x, int maxPossibleDsepPathLength) Identifies and returns a list of possible d-separating nodes relative to a specified node in the graph.voidremoveByPossibleDsep(IndependenceTest test, SepsetMap sepsets) Remove edges by the possible m-separation rule.semidirectedPaths(Node node1, Node node2, int maxLength) Finds all semi-directed paths between two nodes up to a maximum length.Finds all treks from node1 to node2 with a maximum length.treksIncludingBidirected(Node node1, Node node2) Finds all possible treks between two nodes, including bidirectional treks.
-
Constructor Details
-
Paths
Constructor for Paths.
- Parameters:
graph- aGraphobject
-
-
Method Details
-
getDag
Generates a directed acyclic graph (DAG) based on the given list of nodes using Raskutti and Uhler's method.- Parameters:
pi- a list of nodes representing the set of vertices in the graphg- the graphverbose- whether to print verbose output- Returns:
- a Graph object representing the generated DAG.
-
getParents
public static Set<Node> getParents(List<Node> pi, int p, Graph g, boolean verbose, boolean allowSelectionBias) Returns the parents of the node at index p, calculated using Pearl's method.- Parameters:
pi- The list of nodes.p- The index.g- The graph.verbose- Whether to print verbose output.allowSelectionBias- whether to allow selection bias; if true, then undirected edges X--Y are uniformly treated as X->L<-Y.- Returns:
- The parents, as a Pair object (parents + score).
-
getValidOrder
Returns a valid causal order for either a DAG or a CPDAG. (bryanandrews)- Parameters:
initialOrder- Variables in the order will be kept as close to this initial order as possible, either the forward order or the reverse order, depending on the next parameter.forward- Whether the variables will be iterated over in forward or reverse direction.- Returns:
- The valid causal order found.
-
getValidOrderMag
Generates a valid topological ordering of nodes in a directed graph without cycles. If the provided graph is cyclic, an IllegalArgumentException is thrown.- Parameters:
initialOrder- the initial list of nodes representing a possible order to processforward- a boolean indicating the direction of the list processing; if true, the initial order is reversed- Returns:
- a valid list of nodes representing the order in which the directed graph can be traversed without breaking dependency constraints
-
makeValidOrder
Reorders the given order into a valid causal order for either a DAG or a CPDAG. (bryanandrews)- Parameters:
order- Variables in the order will be kept as close to this initial order as possible, either the forward order or the reverse order, depending on the next parameter.
-
isLegalDag
public boolean isLegalDag()Checks if the graph passed as parameter is a legal directed acyclic graph (DAG).- Returns:
- true if the graph is a legal DAG, false otherwise.
-
isLegalCpdag
public boolean isLegalCpdag()Checks if the current graph is a legal CPDAG (completed partially directed acyclic graph).- Returns:
- true if the graph is a legal CPDAG, false otherwise.
-
isLegalMpdag
public boolean isLegalMpdag()Checks if the given graph is a legal Maximal Partial Directed Acyclic Graph (MPDAG). A MPDAG is considered legal if it is equal to a CPDAG where additional edges have been oriented by Knowledge, with Meek rules applied for maximum orientation. The test is performed by attemping to convert the graph to a CPDAG using the DAG to CPDAG transformation and testing whether that graph is a legal CPDAG. Finally, we test to see whether the obtained graph is equal to the original graph.- Returns:
- true if the MPDAG is legal, false otherwise.
-
isLegalMpag
public boolean isLegalMpag()Checks if the given Maximal Ancestral Graph (MAG) is legal. A MAG is considered legal if it is equal to a PAG where additional edges have been oriented by Knowledge, with final FCI rules applied for maximum orientation. The test is performed by attemping to convert the graph to a PAG using the DAG to CPDAG transformation and testing whether that graph is a legal PAG. Finally, we test to see whether the obtained graph is equal to the original graph.The user may choose to use the rules from Zhang (2008) or the rules from Spirtes et al. (2000).
- Returns:
- true if the MPDAG is legal, false otherwise.
-
isLegalMag
public boolean isLegalMag()Checks if the given graph is a legal mag.- Returns:
- true if the graph is a legal mag, false otherwise
-
isLegalPag
public boolean isLegalPag()Checks if the given Directed Acyclic Graph (DAG) is a Legal Partial Ancestral Graph (PAG).- Returns:
- true if the graph is a Legal PAG, false otherwise
-
maxCliques
Returns a set of all maximum cliques in the graph.- Returns:
- a set of sets of nodes representing the maximum cliques in the graph
-
connectedComponents
Returns a list of connected components in the graph.- Returns:
- A list of connected components, where each component is represented as a list of nodes.
-
directedPaths
Finds all directed paths from node1 to node2 with a maximum length.- Parameters:
node1- the starting nodenode2- the destination nodemaxLength- the maximum length of the paths- Returns:
- a list of lists containing the directed paths from node1 to node2
-
semidirectedPaths
Finds all semi-directed paths between two nodes up to a maximum length.- Parameters:
node1- the starting nodenode2- the ending nodemaxLength- the maximum path length- Returns:
- a list of all semi-directed paths between the two nodes
-
amenablePathsMpdagMag
Finds amenable paths from the given source node to the given destination node with a maximum length.- Parameters:
node1- the source nodenode2- the destination nodemaxLength- the maximum length of the paths- Returns:
- a list of amenable paths from the source node to the destination node, each represented as a list of nodes
-
amenablePathsPag
Finds amenable paths from the given source node to the given destination node with a maximum length, for a PAG. These are semidirected paths that start with a visible edge out of node1.- Parameters:
node1- the source nodenode2- the destination nodemaxLength- the maximum length of the paths- Returns:
- a list of amenable paths from the source node to the destination node, each represented as a list of nodes
-
allPaths
Finds all paths from node1 to node2 within a specified maximum length.- Parameters:
node1- The starting node.node2- The target node.maxPathLength- The maximum length of the paths.- Returns:
- A list of paths, where each path is a list of nodes.
-
allPaths
public Set<List<Node>> allPaths(Node node1, Node node2, int maxLength, Set<Node> conditionSet, boolean allowSelectionBias) Finds all paths between two nodes within a given maximum length, considering optional condition set and selection bias.- Parameters:
node1- the starting nodenode2- the target nodemaxLength- the maximum length of each pathconditionSet- a set of nodes that need to be included in the path (optional)allowSelectionBias- if true, undirected edges are interpreted as selection bias; otherwise, as directed edges in one direction or the other.- Returns:
- a set of paths between node1 and node2 that satisfy the conditions
-
allPaths
public Set<List<Node>> allPaths(Node node1, Node node2, int minLength, int maxLength, Set<Node> conditionSet, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Finds all paths between two nodes satisfying certain conditions.- Parameters:
node1- the starting nodenode2- the ending nodeminLength- the minimum length of paths to considermaxLength- the maximum length of paths to considerconditionSet- a set of nodes that must be present in the pathsancestors- a map representing the ancestry relationships of nodesallowSelectionBias- true if selection bias is allowed, false otherwise- Returns:
- a set of lists representing all paths between node1 and node2
-
allPathsOutOf
public Set<List<Node>> allPathsOutOf(Node node1, int maxLength, Set<Node> conditionSet, boolean allowSelectionBias) Generates all paths out of a given node within a specified maximum length and conditional set.- Parameters:
node1- The starting node.maxLength- The maximum length of each path.conditionSet- The set of nodes that must be present in each path.allowSelectionBias- Determines whether to allow selection bias when choosing the next node to visit.- Returns:
- A set containing all generated paths as lists of nodes.
-
allDirectedPaths
Finds all directed paths from node1 to node2 with a maximum length.- Parameters:
node1- The starting node.node2- The target node.maxLength- The maximum length of the paths.- Returns:
- A list of lists of nodes representing the directed paths from node1 to node2.
-
treks
Finds all treks from node1 to node2 with a maximum length.- Parameters:
node1- the starting nodenode2- the destination nodemaxLength- the maximum length of the treks- Returns:
- a list of lists of nodes representing each trek from node1 to node2
-
treksIncludingBidirected
Finds all possible treks between two nodes, including bidirectional treks.- Parameters:
node1- The starting node.node2- The ending node.- Returns:
- A List of Lists representing all treks between the given nodes.
-
markovBlanket
Returns the Markov Blanket of a given node in the graph.- Parameters:
node- the node for which the Markov Blanket needs to be computed- Returns:
- a set of nodes that constitute the Markov Blanket of the given node
-
district
Retrieves the set of nodes that belong to the same district as the given node.- Parameters:
node- the node from which to start the district search- Returns:
- the set of nodes that belong to the same district as the given node
-
existsDirectedPath
Checks if a directed path exists between two nodes within a certain depth.- Parameters:
node1- the first node in the pathnode2- the second node in the pathdepth- the maximum depth to search for the path- Returns:
- true if a directed path exists between the two nodes within the given depth, false otherwise
-
existsSemiDirectedPath
existsSemiDirectedPath.
-
getMConnectedVars
Retrieves the set of nodes that are connected to the given nodeyand are also present in the set of nodesz.- Parameters:
y- The node for which to find the connected nodes.z- The set of nodes to be considered for connecting nodes.- Returns:
- The set of nodes that are connected to
yand present inz.
-
getMConnectedVars
getMConnectedVars.
-
getDescendantsMap
Return a map from each node to its collection of descendants.- Returns:
- This map.
-
getAncestorsMap
Return a map from each node to its collection of ancestors.- Returns:
- This map.
-
isAncestorOfAnyZ
Return true if b is an ancestor of any node in z -
existsInducingPathDFS
Determines whether an inducing path exists between node1 and node2, given a set O of observed nodes and a set sem of conditioned nodes.- Parameters:
x- the first node.y- the second node.selectionVariables- the set of selection variables.- Returns:
- true if an inducing path exists, false if not.
-
existsInducingPathVisit
public boolean existsInducingPathVisit(Node a, Node b, Node x, Node y, Set<Node> selectionVariables, LinkedList<Node> path) Determines whether an inducing path exists between two nodes in a graph.- Parameters:
a- the first node in the graphb- the second node in the graphx- the first measured node in the graphy- the second measured node in the graphselectionVariables- the set of selection variablespath- the path to check- Returns:
- true if an inducing path exists, false if not
-
existsInducingPathBFS
Breadth-first version of the âinducing-path exists?â test.- Parameters:
x- first measured nodey- second measured nodeselectionVariables- set of selection variables (Z)- Returns:
- true iff there is an inducing path from x to y
-
existsInducingPath
Determines whether an inducing path exists between two nodes in a graph. This is a breadth-first implementation.- Parameters:
x- the first node in the graphy- the second node in the graphselectionVariables- the set of selection variables- Returns:
- true if an inducing path exists, false if not
-
getInducingPath
This method calculates the inducing path between two measured nodes in a graph.- Parameters:
x- the first measured node in the graphy- the second measured node in the graphselectionVariables- the set of selection variables- Returns:
- the inducing path between node x and node y, or null if no inducing path exists
- Throws:
IllegalArgumentException- if either x or y is not of NodeType.MEASURED
-
possibleDsep
Identifies and returns a list of possible d-separating nodes relative to a specified node in the graph. The search is constrained by the specified maximum path length.- Parameters:
x- the target node for which possible d-separating nodes are to be identifiedmaxPossibleDsepPathLength- the maximum allowable path length for determining d-separating nodes; a value of -1 indicates no explicit limit- Returns:
- a sorted list of nodes that are potential d-separators for the specified node, ordered in descending order
-
removeByPossibleDsep
public void removeByPossibleDsep(IndependenceTest test, SepsetMap sepsets) throws InterruptedException Remove edges by the possible m-separation rule.- Parameters:
test- The independence test to use to remove edges.sepsets- A sepset map to which sepsets should be added. May be null, in which case sepsets will not be recorded.- Throws:
InterruptedException- if any
-
dsep
Returns D-SEP(x, y) for a maximal ancestral graph G (or inducing path graph G, as in Causation, Prediction and Search).We trust the user to make sure the given graph is a MAG or IPG; we don't check this.
- Parameters:
x- The one endpoint.y- The other endpoint.- Returns:
- D-SEP(x, y) for MAG/IPG G.
-
isSatisfyBackDoorCriterion
Check to see if a set of variables Z satisfies the back-door criterion relative to node x and node y. (author Kevin V. Bui (March 2020). -
getSepset
public Set<Node> getSepset(Node x, Node y, boolean allowSelectionBias, IndependenceTest test, int depth) Finds a sepset for x and y, if there is one; otherwise, returns null.- Parameters:
x- The first node.y- The second node.allowSelectionBias- Whether to allow selection bias.test- The independence test to use.depth- The maximum depth to search for a sepset.- Returns:
- A sepset for x and y, if there is one; otherwise, null.
-
getSepsetContaining
public Set<Node> getSepsetContaining(Node x, Node y, Set<Node> containing, int maxPathLength) throws InterruptedException Retrieves a sepset (a set of nodes) between two given nodes.- Parameters:
x- the first nodey- the second nodecontaining- the set of nodes that the sepset must containmaxPathLength- the maximum length of the path to search for the blocking set- Returns:
- the sepset between the two nodes
- Throws:
InterruptedException- if any.
-
isMConnectedTo
Determmines whether x and y are d-connected given z. -
isMConnectingPath
Checks if the given path is an m-connecting path.- Parameters:
path- The path to check.conditioningSet- The set of nodes to check reachability against.isPag- Determines if selection bias is allowed in the m-connection procedure.- Returns:
trueif the given path is an m-connecting path,falseotherwise.
-
isMConnectingPath
public boolean isMConnectingPath(List<Node> path, Set<Node> conditioningSet, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Checks if the given path is an m-connecting path and doens't contain duplicate nodes.- Parameters:
path- The path to check.conditioningSet- The set of nodes to check reachability against.ancestors- The ancestors of each node in the graph.allowSelectionBias- Determines if selection bias is allowed in the m-connection procedure.- Returns:
trueif the given path is an m-connecting path,falseotherwise.
-
isMConnectedTo
public boolean isMConnectedTo(Node x, Node y, Set<Node> z, Map<Node, Set<Node>> ancestors, boolean isPag) Detemrmines whether x and y are d-connected given z. -
defVisiblePag
Returns true if the edge form A to B is a definitely visible edge in a PAG.- Parameters:
A- The one node.B- The other node.- Returns:
- True if so.
-
existsDirectedCycle
public boolean existsDirectedCycle()existsDirectedCycle.
- Returns:
- a boolean
-
existsDirectedPath
Checks if a directed path exists between two nodes in a graph.- Parameters:
node1- the starting node of the pathnode2- the target node of the path- Returns:
- true if a directed path exists from node1 to node2, false otherwise
-
existsDirectedPath
public boolean existsDirectedPath(Node node1, Node node2, org.apache.commons.lang3.tuple.Pair<Node, Node> without) Checks if a directed path exists between two nodes in a graph, ignoring a specified edge.- Parameters:
node1- the starting node of the pathnode2- the target node of the pathwithout- the edge to ignore. If null, no edge is ignored.- Returns:
- true if a directed path exists from node1 to node2, false otherwise
-
existsSemiDirectedPath
existsSemiDirectedPath.
-
existsTrek
Determines whether a trek exists between two nodes in the graph. A trek exists if there is a directed path between the two nodes or else, for some third node in the graph, there is a path to each of the two nodes in question. -
getDescendants
Returns a list of all descendants of the given node.- Parameters:
node- The node for which to find descendants.- Returns:
- A list of all descendant nodes.
-
getDescendants
Retrieves the descendants of the given list of nodes.- Parameters:
nodes- The list of nodes to find descendants for.- Returns:
- A list of nodes that are descendants of the given nodes.
-
isAncestorOf
Determines whether one node is an ancestor of another. -
getAncestors
Retrieves the ancestors of a specified `Node` in the graph.- Parameters:
node- The node whose ancestors are to be retrieved.- Returns:
- A list of ancestors for the specified `Node`.
-
getAncestors
Returns a list of all ancestors of the given nodes.- Parameters:
nodes- the list of nodes for which to find ancestors- Returns:
- a list containing all the ancestors of the given nodes
-
isDescendentOf
Determines whether one node is a descendent of another. -
definiteNonDescendent
added by ekorber, 2004/06/12 -
isMSeparatedFrom
Determines whether one n ode is d-separated from another. According to Spirtes, Richardson and Meek, two nodes are d- connected given some conditioning set Z if there is an acyclic undirected path U between them, such that every collider on U is an ancestor of some element in Z and every non-collider on U is not in Z. Two elements are d-separated just in case they are not d-connected. A collider is a node which two edges hold in common for which the endpoints leading into the node are both arrow endpoints.Precondition: This graph is a DAG. Please don't violate this constraint; weird things can happen!
- Parameters:
node1- the first node.node2- the second node.z- the conditioning set.isPag- whether to allow selection bias; if true, then undirected edges X--Y are uniformly treated as X->L<-Y.- Returns:
- true if node1 is d-separated from node2 given set t, false if not.
-
isMSeparatedFrom
public boolean isMSeparatedFrom(Node node1, Node node2, Set<Node> z, Map<Node, Set<Node>> ancestors, boolean allowSelectionBias) Checks if two nodes are M-separated.- Parameters:
node1- The first node.node2- The second node.z- The set of nodes to be excluded from the path.ancestors- A map containing the ancestors of each node.allowSelectionBias- whether to allow selection bias; if true, then undirected edges X--Y are uniformly treated as X->L<-Y.- Returns:
trueif the two nodes are M-separated,falseotherwise.
-
isDirected
Checks if there is a directed edge from node1 to node2 in the graph.- Parameters:
node1- the source nodenode2- the destination node- Returns:
- true if there is a directed edge from node1 to node2, false otherwise
-
isUndirected
Checks if the edge between two nodes in the graph is undirected.- Parameters:
node1- the first nodenode2- the second node- Returns:
- true if the edge is undirected, false otherwise
-
possibleAncestor
possibleAncestor.
-
anteriority
Returns the set of nodes that are in the anteriority of the given nodes in the graph.- Parameters:
X- the nodes for which the anteriority needs to be determined- Returns:
- the set of nodes in the anteriority of the given nodes
-
adjustmentSets
public List<Set<Node>> adjustmentSets(Node source, Node target, int maxNumSets, int maxDistanceFromEndpoint, int nearWhichEndpoint, int maxPathLength) An adjustment set for a pair of nodes <source, target> for a CPDAG is a set of nodes that blocks all paths from the source to the target that cannot contribute to a calculation for the total effect of the source on the target in any DAG in a CPDAG while not blocking any path from the source to the target that could be causal. In typical causal graphs, multiple adjustment sets may exist for a given pair of nodes. This method returns up to maxNumSets adjustment sets for the pair of nodes <source, target> fitting a certain description.The description is as follows. We look for adjustment sets of varaibles that are close to either the source or the target (or either) in the graph. We take all possibly causal paths from the source to the target into account but only consider other paths up to a certain specified length. (This maximum length can be unlimited for small graphs.)
Within this description, we list adjustment sets in order or increasing size.
Hopefully, these parameters along with the size ordering can help to give guidance for the user to choose the best adjustment set for their purposes when multiple adjustment sets are possible.
This currently will only work for DAGs and CPDAGs.
- Parameters:
source- The source node whose sets will be used for adjustment.target- The target node whose sets will be adjusted to match the source node.maxNumSets- The maximum number of sets to be adjusted. If this value is less than or equal to 0, all sets in the target node will be adjusted to match the source node.maxDistanceFromEndpoint- The maximum distance from the endpoint of the trek to consider for adjustment.nearWhichEndpoint- The endpoint(s) to consider for adjustment; 1 = near the source, 2 = near the target, 3 = near either.maxPathLength- The maximum length of the path to consider for backdoor paths. If a value of -1 is given, all paths will be considered.- Returns:
- A list of adjustment sets for the pair of nodes <source, target>. Return an smpty list if source == target or there is no amenable path from source to target.
-
isAcyclic
public boolean isAcyclic()Determines whether the graph is acyclic, meaning it does not contain any directed cycles.- Returns:
- true if the graph is acyclic; false otherwise
-
isMaximal
public boolean isMaximal()Determines if the current graph configuration is maximal. A graph configuration is considered maximal if for every pair of non-adjacent nodes, there does not exist an inducing path between them considering the selected nodes.- Returns:
- true if the graph configuration is maximal, otherwise false.
-