Package edu.cmu.tetrad.graph
Interface Graph
- All Superinterfaces:
Serializable
,TetradSerializable
- All Known Implementing Classes:
Dag
,EdgeListGraph
,LagGraph
,SemGraph
,TimeLagGraph
Implements a graph capable of storing edges of type N1 *-# N2 where * and # are endpoints of type Endpoint.
We stipulate by extending TetradSerializable that all graphs implementing this interface are serializable. This is because for Tetrad they must be serializable. (For randomUtil, in order to be able to cancelAll operations, they must be serializable.)
- Version:
- $Id: $Id
- Author:
- josephramsey
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
ConstantserialVersionUID=23L
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAmbiguousTriple
(Node x, Node y, Node z) addAmbiguousTriple.void
addAttribute
(String key, Object value) addAttribute.boolean
addBidirectedEdge
(Node node1, Node node2) Adds a bidirected edges <-> to the graph.boolean
addDirectedEdge
(Node node1, Node node2) Adds a directed edge --> to the graph.void
addDottedUnderlineTriple
(Node x, Node y, Node z) addDottedUnderlineTriple.boolean
Adds the specified edge to the graph, provided it is not already in the graph.boolean
Adds a node to the graph.boolean
addNondirectedEdge
(Node node1, Node node2) Adds a nondirected edges o-o to the graph.boolean
addPartiallyOrientedEdge
(Node node1, Node node2) Adds a partially oriented edge o-> to the graph.void
Adds a PropertyChangeListener to the graph.void
addUnderlineTriple
(Node x, Node y, Node z) addUnderlineTriple.boolean
addUndirectedEdge
(Node node1, Node node2) Adds an undirected edge --- to the graph.void
clear()
Removes all nodes (and therefore all edges) from the graph.boolean
containsEdge
(Edge edge) Determines whether this graph contains the given edge.boolean
containsNode
(Node node) Determines whether this graph contains the given node.boolean
Determines whether this graph is equal to some other graph, in the sense that they contain the same nodes and the sets of edges defined over these nodes in the two graphs are isomorphic typewise.default boolean
existsSemidirectedPath
(Node node1, Node node2) Determines whether there is a semidirected path from node1 to node2.void
fullyConnect
(Endpoint endpoint) Removes all edges from the graph and fully connects it using #-# edges, where # is the given endpoint.getAdjacentNodes
(Node node) getAdjacentNodes.getAllAttributes.getAmbiguousTriples.getAttribute
(String key) getAttribute.getChildren
(Node node) getChildren.int
getDegree.int
getDegree.getDirectedEdge
(Node node1, Node node2) getDirectedEdge.getDottedUnderlines.getEdge.getEdges()
getEdges.getEdges.getEdges.getEndpoint
(Node node1, Node node2) getEndpoint.int
getIndegree
(Node node) getIndegree.getNode.getNodeNames.getNodes()
getNodes.getNodesInTo
(Node node, Endpoint n) Nodes adjacent to the given node with the given proximal endpoint.getNodesOutTo
(Node node, Endpoint n) Nodes adjacent to the given node with the given distal endpoint.int
getNumEdges.int
getNumEdges
(Node node) getNumEdges.int
getNumNodes.int
getOutdegree
(Node node) getOutdegree.getParents
(Node node) getParents.getSepset
(Node n1, Node n2, IndependenceTest test) Returns the set of nodes that form the separating set between two given nodes.getTimeLagGraph.getUnderLines.boolean
isAdjacentTo
(Node node1, Node node2) isAdjacentTo.boolean
isAmbiguousTriple
(Node x, Node y, Node z) States whether r-s-r is an underline triple or not.default boolean
isAncestorOf
(Node node1, Node node2) Determines whether one node is an ancestor of another.boolean
isChildOf.boolean
isDefCollider
(Node node1, Node node2, Node node3) Added by ekorber, 2004/6/9.boolean
isDefNoncollider
(Node node1, Node node2, Node node3) Added by ekorber, 2004/6/9.boolean
isExogenous
(Node node) isExogenous.boolean
isParameterizable
(Node node) isParameterizable.boolean
isParentOf
(Node node1, Node node2) Determines whether node1 is a parent of node2.boolean
isTimeLagModel.boolean
isUnderlineTriple
(Node x, Node y, Node z) States whether r-s-r is an underline triple or not.paths()
paths.void
removeAmbiguousTriple
(Node x, Node y, Node z) removeAmbiguousTriple.void
removeAttribute
(String key) removeAttribute.void
removeDottedUnderlineTriple
(Node x, Node y, Node z) removeDottedUnderlineTriple.boolean
removeEdge
(Edge edge) Removes the given edge from the graph.boolean
removeEdge
(Node node1, Node node2) Removes an edge between two given nodes.boolean
removeEdges
(Node node1, Node node2) Removes all edges connecting node A to node B.boolean
removeEdges
(Collection<Edge> edges) Iterates through the list and removes any permissible edges found.boolean
removeNode
(Node node) Removes a node from the graph.boolean
removeNodes
(List<Node> nodes) Iterates through the list and removes any permissible nodes found.void
removeTriplesNotInGraph.void
removeUnderlineTriple
(Node x, Node y, Node z) removeUnderlineTriple.void
reorientAllWith
(Endpoint endpoint) Reorients all edges in the graph with the given endpoint.void
setAmbiguousTriples
(Set<Triple> triples) setAmbiguousTriples.void
setDottedUnderLineTriples
(Set<Triple> triples) setDottedUnderLineTriples.boolean
setEndpoint
(Node from, Node to, Endpoint endPoint) Sets the endpoint type at the 'to' end of the edge from 'from' to 'to' to the given endpoint.void
setNodes.void
setUnderLineTriples
(Set<Triple> triples) setUnderLineTriples.Constructs and returns a subgraph consisting of a given subset of the nodes of this graph together with the edges between them.toString()
toString.void
transferAttributes
(Graph graph) transferAttributes.void
transferNodesAndEdges
(Graph graph) Transfers nodes and edges from one graph to another.
-
Field Details
-
serialVersionUID
static final long serialVersionUIDConstantserialVersionUID=23L
- See Also:
-
-
Method Details
-
addBidirectedEdge
-
addDirectedEdge
-
addUndirectedEdge
-
addNondirectedEdge
-
addPartiallyOrientedEdge
-
addEdge
-
addNode
-
addPropertyChangeListener
Adds a PropertyChangeListener to the graph.- Parameters:
e
- aPropertyChangeListener
object
-
clear
void clear()Removes all nodes (and therefore all edges) from the graph. -
containsEdge
-
containsNode
-
equals
Determines whether this graph is equal to some other graph, in the sense that they contain the same nodes and the sets of edges defined over these nodes in the two graphs are isomorphic typewise. That is, if node A and B exist in both graphs, and if there are, e.g., three edges between A and B in the first graph, two of which are directed edges and one of which is an undirected edge, then in the second graph there must also be two directed edges and one undirected edge between nodes A and B. -
fullyConnect
-
reorientAllWith
-
getAdjacentNodes
-
getChildren
-
getDegree
int getDegree()getDegree.
- Returns:
- the connectivity of the graph.
-
getEdge
-
getDirectedEdge
-
getEdges
-
getEdges
-
getEdges
-
getEndpoint
-
getIndegree
-
getDegree
-
getNode
-
getNodes
-
setNodes
-
getNodeNames
-
getNumEdges
int getNumEdges()getNumEdges.
- Returns:
- the number of edges in the (entire) graph.
-
getNumEdges
-
getNumNodes
int getNumNodes()getNumNodes.
- Returns:
- the number of nodes in the graph.
-
getOutdegree
-
getParents
-
isAdjacentTo
-
isChildOf
-
isParentOf
-
isDefNoncollider
-
isDefCollider
-
isExogenous
-
getNodesInTo
-
getNodesOutTo
-
removeEdge
-
removeEdge
-
removeEdges
Removes all edges connecting node A to node B. In most cases, this will remove at most one edge, but since multiple edges are permitted in some graph implementations, the number will in some cases be greater than one. -
removeEdges
Iterates through the list and removes any permissible edges found. The order in which edges are added is the order in which they are presented in the iterator.- Parameters:
edges
- aCollection
object- Returns:
- true if edges were added, false if not.
-
removeNode
-
removeNodes
-
setEndpoint
-
subgraph
-
toString
-
transferNodesAndEdges
Transfers nodes and edges from one graph to another. One way this is used is to change graph types. One constructs a new graph based on the old graph, and this method is called to transfer the nodes and edges of the old graph to the new graph.- Parameters:
graph
- the graph from which nodes and edges are to be pilfered.- Throws:
IllegalArgumentException
- This exception is thrown if adding some node.
-
transferAttributes
transferAttributes.
- Parameters:
graph
- aGraph
object- Throws:
IllegalArgumentException
- if any.
-
paths
-
isParameterizable
-
isTimeLagModel
boolean isTimeLagModel()isTimeLagModel.
- Returns:
- true if this is a time lag model, in which case getTimeLagGraph() returns the graph.
-
getTimeLagGraph
TimeLagGraph getTimeLagGraph()getTimeLagGraph.
- Returns:
- the underlying time lag model, if there is one; otherwise, returns null.
-
getSepset
Returns the set of nodes that form the separating set between two given nodes. A separating set is a set of nodes that, when conditioned on, renders the given nodes d-separated.- Parameters:
n1
- the first noden2
- the second nodetest
- the independence test to use- Returns:
- the set of nodes that form the separating set between the two given nodes
-
getAllAttributes
-
getAttribute
-
removeAttribute
-
addAttribute
-
getUnderLines
-
getDottedUnderlines
-
getAmbiguousTriples
-
setAmbiguousTriples
-
isAmbiguousTriple
-
isUnderlineTriple
-
addAmbiguousTriple
-
addUnderlineTriple
-
addDottedUnderlineTriple
-
removeAmbiguousTriple
-
removeUnderlineTriple
-
removeDottedUnderlineTriple
-
setUnderLineTriples
-
setDottedUnderLineTriples
-
removeTriplesNotInGraph
void removeTriplesNotInGraph()removeTriplesNotInGraph.
-
isAncestorOf
-
existsSemidirectedPath
-