Interface DataflowGraphVertexFunctionDefinition

Arguments required to construct a vertex which represents the definition of a function in the DataflowGraph|dataflow graph.

See

isFunctionDefinitionVertex - to check if a vertex is a function definition vertex

interface DataflowGraphVertexFunctionDefinition {
    cds: undefined | ControlDependency[];
    environment?: REnvironmentInformation;
    exitPoints: readonly ExitPoint[];
    id: NodeId;
    indicesCollection?: ContainerIndicesCollection;
    link?: DataflowGraphVertexAstLink;
    params: Record<NodeId, boolean>;
    subflow: DataflowFunctionFlowInformation;
    tag: FunctionDefinition;
    [key: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: unknown

Hierarchy-Diagram

UML class diagram of DataflowGraphVertexFunctionDefinition

Properties

cds environment? exitPoints id indicesCollection? link? params subflow tag

Properties

cds

cds: undefined | ControlDependency[]

See

ControlDependency - the collection of control dependencies which have an influence on whether the vertex is executed.

Optionalenvironment

environment?: REnvironmentInformation

The environment in which the function is defined (this is only attached if the DFG deems it necessary).

exitPoints

exitPoints: readonly ExitPoint[]

All exit points of the function definitions. In other words: last expressions/return calls

id

id: NodeId

The id of the node (the id assigned by the ParentInformation decoration). This unanimously identifies the vertex in the DataflowGraph|dataflow graph as well as the corresponding NormalizedAst|normalized AST.

OptionalindicesCollection

indicesCollection?: ContainerIndicesCollection

this attribute links a vertex to indices (pointer links) it may be affected by or related to

Optionallink

link?: DataflowGraphVertexAstLink

Describes the collection of AST vertices that contributed to this vertex. For example, this is useful with replacement operators, telling you which assignment operator caused them

params

params: Record<NodeId, boolean>

Maps each param to whether it is read, this is an estimate!

subflow

subflow: DataflowFunctionFlowInformation

The static subflow of the function definition, constructed within processFunctionDefinition. If the vertex is (for example) a function, it can have a subgraph which is used as a template for each call. This is the body of the function.

Readonlytag

tag: FunctionDefinition

Used to identify and separate different types of vertices.

Settings

Member Visibility

On This Page

Properties