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.)
- Author:
- josephramsey
- See Also:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAmbiguousTriple
(Node x, Node y, Node z) void
addAttribute
(String key, Object value) 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) 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) 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.void
fullyConnect
(Endpoint endpoint) Removes all edges from the graph and fully connects it using #-# edges, where # is the given endpoint.getAdjacentNodes
(Node node) getAttribute
(String key) getChildren
(Node node) int
int
getDirectedEdge
(Node node1, Node node2) getEdges()
getEndpoint
(Node node1, Node node2) int
getIndegree
(Node node) 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
int
getNumEdges
(Node node) int
int
getOutdegree
(Node node) getParents
(Node node) boolean
isAdjacentTo
(Node node1, Node node2) boolean
isAmbiguousTriple
(Node x, Node y, Node z) States whether r-s-r is an underline triple or not.boolean
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) boolean
isParameterizable
(Node node) boolean
isParentOf
(Node node1, Node node2) Determines whether node1 is a parent of node2.boolean
boolean
isUnderlineTriple
(Node x, Node y, Node z) States whether r-s-r is an underline triple or not.paths()
void
removeAmbiguousTriple
(Node x, Node y, Node z) void
removeAttribute
(String key) void
removeDottedUnderlineTriple
(Node x, Node y, Node z) boolean
removeEdge
(Edge edge) Removes the given edge from the graph.boolean
removeEdge
(Node node1, Node node2) Removes the edge connecting the two given nodes, provided there is exactly one such edge.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
void
removeUnderlineTriple
(Node x, Node y, Node z) void
reorientAllWith
(Endpoint endpoint) Reorients all edges in the graph with the given endpoint.void
setAmbiguousTriples
(Set<Triple> triples) void
setDottedUnderLineTriples
(Set<Triple> triples) 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
void
setUnderLineTriples
(Set<Triple> triples) Constructs and returns a subgraph consisting of a given subset of the nodes of this graph together with the edges between them.toString()
void
transferAttributes
(Graph graph) void
transferNodesAndEdges
(Graph graph) Transfers nodes and edges from one graph to another.
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
-
Method Details
-
addBidirectedEdge
Adds a bidirected edges <-> to the graph. -
addDirectedEdge
Adds a directed edge --> to the graph. -
addUndirectedEdge
Adds an undirected edge --- to the graph. -
addNondirectedEdge
Adds a nondirected edges o-o to the graph. -
addPartiallyOrientedEdge
Adds a partially oriented edge o-> to the graph. -
addEdge
Adds the specified edge to the graph, provided it is not already in the graph.- Returns:
- true if the edge was added, false if not.
-
addNode
Adds a node to the graph. Precondition: The proposed name of the node cannot already be used by any other node in the same graph.- Returns:
- true if nodes were added, false if not.
-
addPropertyChangeListener
Adds a PropertyChangeListener to the graph. -
clear
void clear()Removes all nodes (and therefore all edges) from the graph. -
containsEdge
Determines whether this graph contains the given edge.- Returns:
- true iff the graph contain 'edge'.
-
containsNode
Determines whether this graph contains the given node.- Returns:
- true iff the graph contains 'node'.
-
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
Removes all edges from the graph and fully connects it using #-# edges, where # is the given endpoint. -
reorientAllWith
Reorients all edges in the graph with the given endpoint. -
getAdjacentNodes
- Returns:
- a mutable list of nodes adjacent to the given node.
-
getChildren
- Returns:
- a mutable list of children for a node.
-
getDegree
int getDegree()- Returns:
- the connectivity of the graph.
-
getEdge
- Returns:
- the edge connecting node1 and node2, provided a unique such edge exists.
- Throws:
UnsupportedOperationException
- if the graph allows multiple edges between node pairs.
-
getDirectedEdge
- Returns:
- the directed edge from node1 to node2, if there is one.
- Throws:
UnsupportedOperationException
- if the graph allows multiple edges between node pairs.
-
getEdges
- Returns:
- the list of edges connected to a particular node. No particular ordering of the edges in the list is guaranteed.
-
getEdges
- Returns:
- the edges connecting node1 and node2.
-
getEdges
- Returns:
- the set of edges in the graph. No particular ordering of the edges in the list is guaranteed.
-
getEndpoint
- Returns:
- the endpoint along the edge from node to node2 at the node2 end.
-
getIndegree
- Returns:
- the number of arrow endpoints adjacent to a node.
-
getDegree
- Returns:
- the number of arrow endpoints adjacent to a node.
-
getNode
- Returns:
- the node with the given string name. In case of accidental duplicates, the first node encountered with the given name is returned. In case no node exists with the given name, null is returned.
-
getNodes
- Returns:
- the list of nodes for the graph.
-
setNodes
-
getNodeNames
- Returns:
- the names of the nodes, in the order of
getNodes
.
-
getNumEdges
int getNumEdges()- Returns:
- the number of edges in the (entire) graph.
-
getNumEdges
- Returns:
- the number of edges in the graph which are connected to a particular node.
-
getNumNodes
int getNumNodes()- Returns:
- the number of nodes in the graph.
-
getOutdegree
- Returns:
- the number of null endpoints adjacent to an edge.
-
getParents
- Returns:
- the list of parents for a node.
-
isAdjacentTo
- Returns:
- true iff node1 is adjacent to node2 in the graph.
-
isChildOf
- Returns:
- true iff node1 is a child of node2 in the graph.
-
isParentOf
Determines whether node1 is a parent of node2. -
isDefNoncollider
Added by ekorber, 2004/6/9.- Returns:
- true if node 2 is a definite noncollider between 1 and 3
-
isDefCollider
Added by ekorber, 2004/6/9.- Returns:
- true if node 2 is a definite collider between 1 and 3
-
isExogenous
- Returns:
- true iff the given node is exogenous in the graph.
-
getNodesInTo
Nodes adjacent to the given node with the given proximal endpoint. -
getNodesOutTo
Nodes adjacent to the given node with the given distal endpoint. -
removeEdge
Removes the given edge from the graph.- Returns:
- true if the edge was removed, false if not.
-
removeEdge
Removes the edge connecting the two given nodes, provided there is exactly one such edge.- Throws:
UnsupportedOperationException
- if multiple edges between node pairs are not supported.
-
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.- Returns:
- true if edges were removed, false if not.
-
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.- Returns:
- true if edges were added, false if not.
-
removeNode
Removes a node from the graph.- Returns:
- true if the node was removed, false if not.
-
removeNodes
Iterates through the list and removes any permissible nodes found. The order in which nodes are removed is the order in which they are presented in the iterator.- Returns:
- true if nodes were added, false if not.
-
setEndpoint
Sets the endpoint type at the 'to' end of the edge from 'from' to 'to' to the given endpoint. Note: NOT CONSTRAINT SAFE -
subgraph
Constructs and returns a subgraph consisting of a given subset of the nodes of this graph together with the edges between them. -
toString
String 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
- Throws:
IllegalArgumentException
-
paths
Paths paths() -
isParameterizable
- Returns:
- true if the given node is parameterizable.
-
isTimeLagModel
boolean isTimeLagModel()- Returns:
- true if this is a time lag model, in which case getTimeLagGraph() returns the graph.
-
getTimeLagGraph
TimeLagGraph getTimeLagGraph()- Returns:
- the underlying time lag model, if there is one; otherwise, returns null.
-
getSepset
-
getAllAttributes
-
getAttribute
-
removeAttribute
-
addAttribute
-
getUnderLines
-
getDottedUnderlines
-
getAmbiguousTriples
-
setAmbiguousTriples
-
isAmbiguousTriple
States whether r-s-r is an underline triple or not. -
isUnderlineTriple
States whether r-s-r is an underline triple or not. -
addAmbiguousTriple
-
addUnderlineTriple
-
addDottedUnderlineTriple
-
removeAmbiguousTriple
-
removeUnderlineTriple
-
removeDottedUnderlineTriple
-
setUnderLineTriples
-
setDottedUnderLineTriples
-
removeTriplesNotInGraph
void removeTriplesNotInGraph()
-