Class DataflowGraph<Vertex, Edge>
Type Parameters
- Vertex extends DataflowGraphVertexInfo = DataflowGraphVertexInfo
- Edge extends DataflowGraphEdge = DataflowGraphEdge
Hierarchy (view full)
- DataflowGraph
Hierarchy-Diagram
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Dataflow Graph<Vertex, Edge>(idMap): DataflowGraph<Vertex, Edge> Type Parameters
- Vertex extends DataflowGraphVertexInfo = DataflowGraphVertexInfo
- Edge extends DataflowGraphEdge = DataflowGraphEdge
Parameters
- idMap: undefined | AstIdMap
Returns DataflowGraph<Vertex, Edge>
Properties
Protectedroot
Contains the vertices of the root level graph (i.e., included those vertices from the complete graph, that are nested within function definitions)
Accessors
id
unknown
- get unknownSideEffects(): Set<UnknownSidEffect>
Retrieves the set of vertices which have side effects that we do not know anything about.
Returns Set<UnknownSidEffect>
Methods
Staticfrom
- from
Json(data): DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge> Constructs a dataflow graph instance from the given JSON data and returns the result. This can be useful for data sent by the flowR server when analyzing it further.
Parameters
- data: DataflowGraphJson
The JSON data to construct the graph from
Returns DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge>
- data: DataflowGraphJson
add
add
- add
Edge(from, to, type): this Returns this
- add
Edge(from, to, type): this Parameters
- from: ReferenceForEdge
- to: ReferenceForEdge
- type: EdgeType
Returns this
- add
Edge(from, to, type): this Parameters
- from: NodeId | ReferenceForEdge
- to: NodeId | ReferenceForEdge
- type: EdgeType
Returns this
add
- add
Vertex(vertex, asRoot?): this Adds a new vertex to the graph, for ease of use, some arguments are optional and filled automatically.
Parameters
- vertex: DataflowGraphVertexArgument & Omit<Vertex, string | number>
The vertex to add
- asRoot: boolean = true
If false, this will only add the vertex but do not add it to the rootIds|root vertices of the graph. This is probably only of use, when you construct dataflow graphs for tests.
Returns this
- vertex: DataflowGraphVertexArgument & Omit<Vertex, string | number>
edges
- edges(): IterableIterator<[NodeId, OutgoingEdges<DataflowGraphEdge>], any, any>
Returns IterableIterator<[NodeId, OutgoingEdges<DataflowGraphEdge>], any, any>
the ids of all edges in the graph together with their edge information
get
- get(id, includeDefinedFunctions?): undefined | [Vertex, OutgoingEdges<DataflowGraphEdge>]
Get the DataflowGraphVertexInfo attached to a node as well as all outgoing edges.
Parameters
- id: NodeId
The id of the node to get
- includeDefinedFunctions: boolean = true
If true this will search function definitions as well and not just the toplevel
Returns undefined | [Vertex, OutgoingEdges<DataflowGraphEdge>]
the node info for the given id (if it exists)
- id: NodeId
get
- get
Vertex(id, includeDefinedFunctions?): undefined | Vertex Get the DataflowGraphVertexInfo attached to a vertex.
Parameters
- id: NodeId
The id of the node to get
- includeDefinedFunctions: boolean = true
If true this will search function definitions as well and not just the toplevel
Returns undefined | Vertex
the node info for the given id (if it exists)
- id: NodeId
has
- has
Vertex(id, includeDefinedFunctions?): boolean Returns true if the graph contains a node with the given id.
Parameters
- id: NodeId
The id to check for
- includeDefinedFunctions: boolean = true
If true this will check function definitions as well and not just the toplevel
Returns boolean
- id: NodeId
ingoing
- ingoing
Edges(id): undefined | IngoingEdges<DataflowGraphEdge> Parameters
- id: NodeId
Returns undefined | IngoingEdges<DataflowGraphEdge>
is
- is
Root(id): boolean Returns true if the root level of the graph contains a node with the given id.
Parameters
- id: NodeId
Returns boolean
mark
merge
- merge
With(otherGraph, mergeRootVertices?): this Merges the other graph into this one (in-place). The return value is only for convenience.
Parameters
- otherGraph: undefined | DataflowGraph<Vertex, Edge>
The graph to merge into this one
- mergeRootVertices: boolean = true
If false, this will only merge the vertices and edges but exclude the root vertices this is probably only of use in the context of function definitions
Returns this
- otherGraph: undefined | DataflowGraph<Vertex, Edge>
outgoing
- outgoing
Edges(id): undefined | OutgoingEdges<DataflowGraphEdge> Parameters
- id: NodeId
Returns undefined | OutgoingEdges<DataflowGraphEdge>
root
set
- set
Definition Of Vertex(reference): void Marks a vertex in the graph to be a definition
Parameters
- reference: IdentifierReference
The reference to the vertex to mark as definition
Returns void
- reference: IdentifierReference
set
- set
Id Map(idMap): void Allows setting the id-map explicitly (which should only be used when, e.g., you plan to compare two dataflow graphs on the same AST-basis)
Parameters
- idMap: AstIdMap
Returns void
update
- update
To Function Call(info): void Marks a vertex in the graph to be a function call with the new information
Parameters
- info: DataflowGraphVertexFunctionCall
The information about the new function call node
Returns void
- info: DataflowGraphVertexFunctionCall
vertices
- vertices(includeDefinedFunctions): IterableIterator<[NodeId, Vertex], any, any>
Parameters
- includeDefinedFunctions: boolean
If true this will iterate over function definitions as well and not just the toplevel
Returns IterableIterator<[NodeId, Vertex], any, any>
the ids of all toplevel vertices in the graph together with their vertex information
- includeDefinedFunctions: boolean
The dataflow graph holds the dataflow information found within the given AST. We differentiate the directed edges in EdgeType and the vertices indicated by DataflowGraphVertexArgument
The vertices of the graph are organized in a hierarchical fashion, with a function-definition node containing the node ids of its subgraph. However, all edges are hoisted at the top level in the form of an (attributed) adjacency list. After the dataflow analysis, all sources and targets of the edges must be part of the vertices. However, this does not have to hold during the construction as edges may point from or to vertices which are yet to be constructed.
All methods return the modified graph to allow for chaining.