@eagleoutice/flowr 2.6.1 → 2.6.2

package/dataflow/graph/dataflowgraph-builder.js

@@ -14,6 +14,9 @@ const edge_1 = require("./edge");
 const default_builtin_config_1 = require("../environments/default-builtin-config");
 const flowr_search_executor_1 = require("../../search/flowr-search-executor");
 const assert_1 = require("../../util/assert");
+/**
+ *
+ */
 function emptyGraph(idMap) {
     return new DataflowGraphBuilder(idMap);
 }
@@ -25,7 +28,6 @@ function emptyGraph(idMap) {
 class DataflowGraphBuilder extends graph_1.DataflowGraph {
     /**
      * Adds a **vertex** for a **function definition** (V1).
-     *
      * @param id - AST node ID
      * @param subflow - Subflow data graph for the defined function.
      * @param exitPoints - Node IDs for exit point vertices.
@@ -52,7 +54,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **vertex** for a **function call** (V2).
-     *
      * @param id - AST node ID
      * @param name - Function name
      * @param args - Function arguments; may be empty
@@ -107,7 +108,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **vertex** for a **variable definition** (V4).
-     *
      * @param id - AST node ID
      * @param name - Variable name
      * @param info - Additional/optional properties.
@@ -130,7 +130,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **vertex** for **variable use** (V5). Intended for creating dataflow graphs as part of function tests.
-     *
      * @param id - AST node id
      * @param name - Variable name
      * @param info - Additional/optional properties; i.e., scope, when, or environment.
@@ -151,7 +150,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **vertex** for a **constant value** (V6).
-     *
      * @param id - AST node ID
      * @param options - Additional/optional properties;
      * @param asRoot - should the vertex be part of the root vertex set of the graph
@@ -196,7 +194,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **read edge**.
-     *
      * @param from - NodeId of the source vertex
      * @param to   - Either a single or multiple target ids.
      *               If you pass multiple this will construct a single edge for each of them.
@@ -206,7 +203,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **read edge** with a query for the from and/or to vertices.
-     *
      * @param from - Either a node id or a query to find the node id.
      * @param to - Either a node id or a query to find the node id.
      * @param input - The input to search in i.e. the dataflow graph.
@@ -217,7 +213,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     /**
      * Adds a **defined-by edge** with from as defined variable, and to
      * as a variable/function contributing to its definition.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definedBy(from, to) {
@@ -225,7 +220,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **defined-by edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     definedByQuery(from, to, data) {
@@ -233,7 +227,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **call edge** with from as caller, and to as callee.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     calls(from, to) {
@@ -241,7 +234,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **call edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     callsQuery(from, to, data) {
@@ -249,7 +241,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **return edge** with from as function, and to as exit point.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     returns(from, to) {
@@ -257,7 +248,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **return edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     returnsQuery(from, to, data) {
@@ -265,7 +255,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **defines-on-call edge** with from as variable, and to as its definition
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definesOnCall(from, to) {
@@ -273,7 +262,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **defines-on-call edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     definesOnCallQuery(from, to, data) {
@@ -281,7 +269,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **defined-by-on-call edge** with from as definition, and to as variable.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definedByOnCall(from, to) {
@@ -289,7 +276,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **defined-by-on-call edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     definedByOnCallQuery(from, to, data) {
@@ -297,7 +283,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds an **argument edge** with from as function call, and to as argument.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     argument(from, to) {
@@ -305,7 +290,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **argument edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     argumentQuery(from, to, data) {
@@ -313,7 +297,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **non-standard evaluation edge** with from as vertex, and to as vertex.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     nse(from, to) {
@@ -321,7 +304,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **non-standard evaluation edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     nseQuery(from, to, data) {
@@ -329,7 +311,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **side-effect-on-call edge** with from as vertex, and to as vertex.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     sideEffectOnCall(from, to) {
@@ -337,7 +318,6 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
     /**
      * Adds a **side-effect-on-call edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
     sideEffectOnCallQuery(from, to, data) {
@@ -353,6 +333,9 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     }
 }
 exports.DataflowGraphBuilder = DataflowGraphBuilder;
+/**
+ *
+ */
 function getBuiltInSideEffect(name) {
     const got = default_builtin_config_1.DefaultBuiltinConfig.find(e => e.names.includes(name));
     if (got?.type !== 'function') {

package/dataflow/graph/diff-dataflow-graph.d.ts

@@ -1,16 +1,26 @@
-import type { FunctionArgument, OutgoingEdges } from './graph';
-import type { GenericDiffConfiguration, GenericDifferenceInformation } from '../../util/diff';
-import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
-import type { GraphDiffContext, NamedGraph } from '../../util/diff-graph';
-import { GraphDifferenceReport } from '../../util/diff-graph';
+import { type FunctionArgument, type OutgoingEdges } from './graph';
+import { type GenericDiffConfiguration, type GenericDifferenceInformation } from '../../util/diff';
+import { type NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { type GraphDiffContext, type NamedGraph, GraphDifferenceReport } from '../../util/diff-graph';
 /**
  * Compare two dataflow graphs and return a report on the differences.
  * If you simply want to check whether they equal, use {@link GraphDifferenceReport#isEqual|`<result>.isEqual()`}.
- *
  * @see {@link diffOfControlFlowGraphs} - for control flow graphs
  */
 export declare function diffOfDataflowGraphs(left: NamedGraph, right: NamedGraph, config?: Partial<GenericDiffConfiguration>): GraphDifferenceReport;
+/**
+ * Checks whether two function argument lists are equal.
+ */
 export declare function equalFunctionArguments(fn: NodeId, a: false | readonly FunctionArgument[], b: false | readonly FunctionArgument[]): boolean;
+/**
+ * Compares two function argument lists and reports differences.
+ */
 export declare function diffFunctionArguments(fn: NodeId, a: false | readonly FunctionArgument[], b: false | readonly FunctionArgument[], ctx: GenericDifferenceInformation<GraphDifferenceReport>): void;
+/**
+ * Compares the vertices of two dataflow graphs and reports differences.
+ */
 export declare function diffVertices(ctx: GraphDiffContext): void;
+/**
+ * Compares two sets of outgoing edges and reports differences.
+ */
 export declare function diffEdges(ctx: GraphDiffContext, id: NodeId, lEdges: OutgoingEdges | undefined, rEdges: OutgoingEdges | undefined): void;

package/dataflow/graph/diff-dataflow-graph.js

@@ -19,7 +19,6 @@ const diff_graph_1 = require("../../util/diff-graph");
 /**
  * Compare two dataflow graphs and return a report on the differences.
  * If you simply want to check whether they equal, use {@link GraphDifferenceReport#isEqual|`<result>.isEqual()`}.
- *
  * @see {@link diffOfControlFlowGraphs} - for control flow graphs
  */
 function diffOfDataflowGraphs(left, right, config) {
@@ -80,6 +79,9 @@ function diffFunctionArgumentsReferences(fn, a, b, ctx) {
     }
     (0, diff_2.diffIdentifierReferences)(a, b, ctx);
 }
+/**
+ * Checks whether two function argument lists are equal.
+ */
 function equalFunctionArguments(fn, a, b) {
     const ctx = {
         report: new diff_graph_1.GraphDifferenceReport(),
@@ -91,6 +93,9 @@ function equalFunctionArguments(fn, a, b) {
     diffFunctionArguments(fn, a, b, ctx);
     return ctx.report.isEqual();
 }
+/**
+ * Compares two function argument lists and reports differences.
+ */
 function diffFunctionArguments(fn, a, b, ctx) {
     if (a === false || b === false) {
         if (a !== b) {
@@ -129,6 +134,9 @@ function diffFunctionArguments(fn, a, b, ctx) {
         }
     }
 }
+/**
+ * Compares the vertices of two dataflow graphs and reports differences.
+ */
 function diffVertices(ctx) {
     // collect vertices from both sides
     const lVert = ctx.left.vertices(true).map(([id, info]) => [id, info]).toArray();
@@ -232,6 +240,9 @@ function diffEdge(edge, otherEdge, ctx, id, target) {
         ctx.report.addComment(`Target of ${id}->${target} in ${ctx.leftname} differs in edge types: ${JSON.stringify([...(0, edge_1.edgeTypesToNames)(edge.types)])} vs ${JSON.stringify([...(0, edge_1.edgeTypesToNames)(otherEdge.types)])}`, { tag: 'edge', from: id, to: target });
     }
 }
+/**
+ * Compares two sets of outgoing edges and reports differences.
+ */
 function diffEdges(ctx, id, lEdges, rEdges) {
     if (lEdges === undefined || rEdges === undefined) {
         if ((lEdges === undefined && !ctx.config.leftIsSubgraph)

package/dataflow/graph/edge.d.ts

@@ -56,7 +56,13 @@ export type EdgeTypeBits = number;
  * Otherwise, use {@link edgeTypesToNames} which handles these cases.
  */
 export declare function edgeTypeToName(type: EdgeType): string;
+/**
+ * Takes joint edge types and splits them into their individual components.
+ */
 export declare function splitEdgeTypes(types: EdgeTypeBits): EdgeType[];
+/**
+ * Takes joint edge types and returns their human-readable names.
+ */
 export declare function edgeTypesToNames(bits: EdgeTypeBits): Set<EdgeTypeName>;
 export declare const enum TraverseEdge {
     /** Do not traverse this edge */
@@ -84,4 +90,7 @@ export declare function edgeIncludesType(type: EdgeTypeBits, typesToInclude: Edg
  * Counterpart of {@link edgeIncludesType}.
  */
 export declare function edgeDoesNotIncludeType(type: EdgeTypeBits, types: EdgeTypeBits): boolean;
+/**
+ * Determines whether an edge should be traversed during dataflow analysis.
+ */
 export declare function shouldTraverseEdge(types: EdgeTypeBits): TraverseEdge;

package/dataflow/graph/edge.js

@@ -57,6 +57,9 @@ const edgeTypeToHumanReadableName = new Map([
 function edgeTypeToName(type) {
     return edgeTypeToHumanReadableName.get(type);
 }
+/**
+ * Takes joint edge types and splits them into their individual components.
+ */
 function splitEdgeTypes(types) {
     const split = [];
     for (const bit of edgeTypeToHumanReadableName.keys()) {
@@ -66,6 +69,9 @@ function splitEdgeTypes(types) {
     }
     return split;
 }
+/**
+ * Takes joint edge types and returns their human-readable names.
+ */
 function edgeTypesToNames(bits) {
     const types = new Set();
     for (const [bit, name] of edgeTypeToHumanReadableName.entries()) {
@@ -97,6 +103,9 @@ function edgeDoesNotIncludeType(type, types) {
 }
 const alwaysTraverseEdgeTypes = EdgeType.Reads | EdgeType.DefinedBy | EdgeType.Argument | EdgeType.Calls;
 const definedByOnCallTypes = EdgeType.DefinesOnCall | EdgeType.DefinedByOnCall;
+/**
+ * Determines whether an edge should be traversed during dataflow analysis.
+ */
 function shouldTraverseEdge(types) {
     if (edgeIncludesType(types, EdgeType.NonStandardEvaluation)) {
         return 0 /* TraverseEdge.Never */;

package/dataflow/graph/graph.d.ts

@@ -1,9 +1,9 @@
 import type { DataflowGraphEdge, EdgeType } from './edge';
 import type { DataflowInformation } from '../info';
-import type { DataflowGraphVertexArgument, DataflowGraphVertexFunctionCall, DataflowGraphVertexInfo } from './vertex';
+import { type DataflowGraphVertexArgument, type DataflowGraphVertexFunctionCall, type DataflowGraphVertexInfo } from './vertex';
 import { EmptyArgument } from '../../r-bridge/lang-4.x/ast/model/nodes/r-function-call';
 import type { Identifier, IdentifierDefinition, IdentifierReference } from '../environments/identifier';
-import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { type NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { LinkTo } from '../../queries/catalog/call-context-query/call-context-query-format';
 /**
@@ -19,7 +19,6 @@ export type DataflowFunctionFlowInformation = Omit<DataflowInformation, 'graph'
  * ```r
  * foo(a = 3, b = 2)
  * ```
- *
  * @see #isNamedArgument
  * @see PositionalFunctionArgument
  */
@@ -32,7 +31,6 @@ export interface NamedFunctionArgument extends IdentifierReference {
  * ```r
  * foo(3, 2)
  * ```
- *
  * @see #isPositionalArgument
  * @see NamedFunctionArgument
  */
@@ -95,7 +93,6 @@ export type UnknownSidEffect = NodeId | {
  * 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.
- *
  * @see {@link DataflowGraph#addEdge|`addEdge`} - to add an edge to the graph
  * @see {@link DataflowGraph#addVertex|`addVertex`} - to add a vertex to the graph
  * @see {@link DataflowGraph#fromJson|`fromJson`} - to construct a dataflow graph object from a deserialized JSON object.
@@ -116,21 +113,17 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     private edgeInformation;
     /**
      * Get the {@link DataflowGraphVertexInfo} attached to a node as well as all outgoing edges.
-     *
      * @param id                      - The id of the node to get
      * @param includeDefinedFunctions - If true this will search function definitions as well and not just the toplevel
      * @returns the node info for the given id (if it exists)
-     *
      * @see #getVertex
      */
     get(id: NodeId, includeDefinedFunctions?: boolean): [Vertex, OutgoingEdges] | undefined;
     /**
      * Get the {@link DataflowGraphVertexInfo} attached to a vertex.
-     *
      * @param id                      - The id of the node to get
      * @param includeDefinedFunctions - If true this will search function definitions as well and not just the toplevel
      * @returns the node info for the given id (if it exists)
-     *
      * @see #get
      */
     getVertex(id: NodeId, includeDefinedFunctions?: boolean): Vertex | undefined;
@@ -138,9 +131,9 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     ingoingEdges(id: NodeId): IngoingEdges | undefined;
     /**
      * Given a node in the normalized AST this either:
-     * * returns the id if the node directly exists in the DFG
-     * * returns the ids of all vertices in the DFG that are linked to this
-     * * returns undefined if the node is not part of the DFG and not linked to any node
+     * returns the id if the node directly exists in the DFG
+     * returns the ids of all vertices in the DFG that are linked to this
+     * returns undefined if the node is not part of the DFG and not linked to any node
      */
     getLinked(nodeId: NodeId): NodeId[] | undefined;
     /** Retrieves the id-map to the normalized AST attached to the dataflow graph */
@@ -157,19 +150,16 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     /**
      * @param includeDefinedFunctions - If true this will iterate over function definitions as well and not just the toplevel
      * @returns the ids of all toplevel vertices in the graph together with their vertex information
-     *
      * @see #edges
      */
     vertices(includeDefinedFunctions: boolean): MapIterator<[NodeId, Vertex]>;
     /**
      * @returns the ids of all edges in the graph together with their edge information
-     *
      * @see #vertices
      */
     edges(): MapIterator<[NodeId, OutgoingEdges]>;
     /**
      * Returns true if the graph contains a node with the given id.
-     *
      * @param id                      - The id to check for
      * @param includeDefinedFunctions - If true this will check function definitions as well and not just the toplevel
      */
@@ -181,12 +171,10 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     rootIds(): ReadonlySet<NodeId>;
     /**
      * Adds a new vertex to the graph, for ease of use, some arguments are optional and filled automatically.
-     *
      * @param vertex - The vertex to add
      * @param asRoot - If false, this will only add the vertex but do not add it to the {@link rootIds|root vertices} of the graph.
      *                 This is probably only of use, when you construct dataflow graphs for tests.
      * @param overwrite - If true, this will overwrite the vertex if it already exists in the graph (based on the id).
-     *
      * @see DataflowGraphVertexInfo
      * @see DataflowGraphVertexArgument
      */
@@ -199,10 +187,9 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     addEdge(from: NodeId | ReferenceForEdge, to: NodeId | ReferenceForEdge, type: EdgeType | number): this;
     /**
      * Merges the other graph into *this* one (in-place). The return value is only for convenience.
-     *
      * @param otherGraph        - The graph to merge into this one
      * @param mergeRootVertices - 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
+     *                            in the context of function definitions
      */
     mergeWith(otherGraph: DataflowGraph<Vertex, Edge> | undefined, mergeRootVertices?: boolean): this;
     private mergeEdges;

package/dataflow/graph/graph.js

@@ -45,7 +45,6 @@ function getReferenceOfArgument(arg) {
  * 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.
- *
  * @see {@link DataflowGraph#addEdge|`addEdge`} - to add an edge to the graph
  * @see {@link DataflowGraph#addVertex|`addVertex`} - to add a vertex to the graph
  * @see {@link DataflowGraph#fromJson|`fromJson`} - to construct a dataflow graph object from a deserialized JSON object.
@@ -74,11 +73,9 @@ class DataflowGraph {
     edgeInformation = new Map();
     /**
      * Get the {@link DataflowGraphVertexInfo} attached to a node as well as all outgoing edges.
-     *
      * @param id                      - The id of the node to get
      * @param includeDefinedFunctions - If true this will search function definitions as well and not just the toplevel
      * @returns the node info for the given id (if it exists)
-     *
      * @see #getVertex
      */
     get(id, includeDefinedFunctions = true) {
@@ -88,11 +85,9 @@ class DataflowGraph {
     }
     /**
      * Get the {@link DataflowGraphVertexInfo} attached to a vertex.
-     *
      * @param id                      - The id of the node to get
      * @param includeDefinedFunctions - If true this will search function definitions as well and not just the toplevel
      * @returns the node info for the given id (if it exists)
-     *
      * @see #get
      */
     getVertex(id, includeDefinedFunctions = true) {
@@ -112,9 +107,9 @@ class DataflowGraph {
     }
     /**
      * Given a node in the normalized AST this either:
-     * * returns the id if the node directly exists in the DFG
-     * * returns the ids of all vertices in the DFG that are linked to this
-     * * returns undefined if the node is not part of the DFG and not linked to any node
+     * returns the id if the node directly exists in the DFG
+     * returns the ids of all vertices in the DFG that are linked to this
+     * returns undefined if the node is not part of the DFG and not linked to any node
      */
     getLinked(nodeId) {
         if (this.vertexInformation.has(nodeId)) {
@@ -152,7 +147,6 @@ class DataflowGraph {
     /**
      * @param includeDefinedFunctions - If true this will iterate over function definitions as well and not just the toplevel
      * @returns the ids of all toplevel vertices in the graph together with their vertex information
-     *
      * @see #edges
      */
     *vertices(includeDefinedFunctions) {
@@ -167,7 +161,6 @@ class DataflowGraph {
     }
     /**
      * @returns the ids of all edges in the graph together with their edge information
-     *
      * @see #vertices
      */
     *edges() {
@@ -175,7 +168,6 @@ class DataflowGraph {
     }
     /**
      * Returns true if the graph contains a node with the given id.
-     *
      * @param id                      - The id to check for
      * @param includeDefinedFunctions - If true this will check function definitions as well and not just the toplevel
      */
@@ -193,12 +185,10 @@ class DataflowGraph {
     }
     /**
      * Adds a new vertex to the graph, for ease of use, some arguments are optional and filled automatically.
-     *
      * @param vertex - The vertex to add
      * @param asRoot - If false, this will only add the vertex but do not add it to the {@link rootIds|root vertices} of the graph.
      *                 This is probably only of use, when you construct dataflow graphs for tests.
      * @param overwrite - If true, this will overwrite the vertex if it already exists in the graph (based on the id).
-     *
      * @see DataflowGraphVertexInfo
      * @see DataflowGraphVertexArgument
      */
@@ -244,10 +234,9 @@ class DataflowGraph {
     }
     /**
      * Merges the other graph into *this* one (in-place). The return value is only for convenience.
-     *
      * @param otherGraph        - The graph to merge into this one
      * @param mergeRootVertices - 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
+     *                            in the context of function definitions
      */
     mergeWith(otherGraph, mergeRootVertices = true) {
         if (otherGraph === undefined) {

package/dataflow/graph/invert-dfg.d.ts

@@ -1,2 +1,5 @@
 import { DataflowGraph } from './graph';
+/**
+ *
+ */
 export declare function invertDfg(graph: DataflowGraph): DataflowGraph;

package/dataflow/graph/invert-dfg.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.invertDfg = invertDfg;
 const graph_1 = require("./graph");
+/**
+ *
+ */
 function invertDfg(graph) {
     const invertedGraph = new graph_1.DataflowGraph(graph.idMap);
     for (const [, v] of graph.vertices(true)) {

package/dataflow/graph/quads.d.ts

@@ -1,4 +1,4 @@
-import type { QuadSerializationConfiguration } from '../../util/quads';
+import { type QuadSerializationConfiguration } from '../../util/quads';
 import type { DataflowGraph } from './graph';
 /**
  * @see cfg2quads

package/dataflow/graph/unknown-replacement.d.ts

@@ -7,5 +7,11 @@ export type ReplacementOperatorHandlerArgs = {
     id: NodeId;
 };
 export type ReplacementOperatorHandler = (args: ReplacementOperatorHandlerArgs) => void;
+/**
+ *
+ */
 export declare function onReplacementOperator(handler: ReplacementOperatorHandler): void;
+/**
+ *
+ */
 export declare function handleReplacementOperator(args: ReplacementOperatorHandlerArgs): void;

package/dataflow/graph/unknown-replacement.js

@@ -3,9 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.onReplacementOperator = onReplacementOperator;
 exports.handleReplacementOperator = handleReplacementOperator;
 const handlers = [];
+/**
+ *
+ */
 function onReplacementOperator(handler) {
     handlers.push(handler);
 }
+/**
+ *
+ */
 function handleReplacementOperator(args) {
     handlers.forEach(handler => handler(args));
 }

package/dataflow/graph/unknown-side-effect.d.ts

@@ -3,5 +3,13 @@ import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-i
 import type { REnvironmentInformation } from '../environments/environment';
 import type { DataflowGraph } from './graph';
 export type UnknownSideEffectHandler = (graph: DataflowGraph, env: REnvironmentInformation, id: NodeId, target?: LinkTo<RegExp | string>) => void;
+/**
+ * Globally registers a handler for unknown side effects.
+ * @see {@link handleUnknownSideEffect} for triggering the handlers.
+ */
 export declare function onUnknownSideEffect(handler: UnknownSideEffectHandler): void;
+/**
+ * Handles an unknown side effect occurring at the given node in the dataflow graph.
+ * @see {@link onUnknownSideEffect} for registering handlers.
+ */
 export declare function handleUnknownSideEffect(graph: DataflowGraph, env: REnvironmentInformation, id: NodeId, target?: LinkTo<RegExp | string>): void;

package/dataflow/graph/unknown-side-effect.js

@@ -3,9 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.onUnknownSideEffect = onUnknownSideEffect;
 exports.handleUnknownSideEffect = handleUnknownSideEffect;
 const handlers = [];
+/**
+ * Globally registers a handler for unknown side effects.
+ * @see {@link handleUnknownSideEffect} for triggering the handlers.
+ */
 function onUnknownSideEffect(handler) {
     handlers.push(handler);
 }
+/**
+ * Handles an unknown side effect occurring at the given node in the dataflow graph.
+ * @see {@link onUnknownSideEffect} for registering handlers.
+ */
 function handleUnknownSideEffect(graph, env, id, target) {
     graph.markIdForUnknownSideEffects(id, target);
     handlers.forEach(handler => handler(graph, env, id, target));