@eagleoutice/flowr 2.6.1 → 2.6.3

package/dataflow/graph/dataflowgraph-builder.d.ts

@@ -1,13 +1,15 @@
-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 { DataflowFunctionFlowInformation, FunctionArgument } from './graph';
-import { DataflowGraph } from './graph';
-import type { IEnvironment, REnvironmentInformation } from '../environments/environment';
-import type { DataflowGraphVertexAstLink, DataflowGraphVertexUse, FunctionOriginInformation } from './vertex';
+import { type DataflowFunctionFlowInformation, type FunctionArgument, DataflowGraph } from './graph';
+import { type IEnvironment, type REnvironmentInformation } from '../environments/environment';
+import { type DataflowGraphVertexAstLink, type DataflowGraphVertexUse, type FunctionOriginInformation } from './vertex';
 import type { ControlDependency } from '../info';
 import type { LinkTo } from '../../queries/catalog/call-context-query/call-context-query-format';
 import type { FlowrSearchLike } from '../../search/flowr-search-builder';
-import type { FlowrAnalysisProvider } from '../../project/flowr-analyzer';
+import type { ReadonlyFlowrAnalysisProvider } from '../../project/flowr-analyzer';
+/**
+ *
+ */
 export declare function emptyGraph(idMap?: AstIdMap): DataflowGraphBuilder;
 export type DataflowGraphEdgeTarget = NodeId | (readonly NodeId[]);
 /**
@@ -18,7 +20,6 @@ export type DataflowGraphEdgeTarget = NodeId | (readonly NodeId[]);
 export declare class DataflowGraphBuilder extends 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.
@@ -33,7 +34,6 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     }, asRoot?: boolean): this;
     /**
      * Adds a **vertex** for a **function call** (V2).
-     *
      * @param id - AST node ID
      * @param name - Function name
      * @param args - Function arguments; may be empty
@@ -55,7 +55,6 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     private addArgumentLinks;
     /**
      * Adds a **vertex** for a **variable definition** (V4).
-     *
      * @param id - AST node ID
      * @param name - Variable name
      * @param info - Additional/optional properties.
@@ -68,7 +67,6 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     }, asRoot?: boolean): this;
     /**
      * 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.
@@ -78,7 +76,6 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     use(id: NodeId, name?: string, info?: Partial<DataflowGraphVertexUse>, asRoot?: boolean): this;
     /**
      * 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
@@ -91,7 +88,6 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     private queryHelper;
     /**
      * 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.
@@ -99,115 +95,101 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     reads(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * 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.
      */
-    readsQuery(from: FromQueryParam, to: ToQueryParam, input: FlowrAnalysisProvider): Promise<this>;
+    readsQuery(from: FromQueryParam, to: ToQueryParam, input: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * 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: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * Adds a **defined-by edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
-    definedByQuery(from: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    definedByQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **call edge** with from as caller, and to as callee.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     calls(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * Adds a **call edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
-    callsQuery(from: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    callsQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **return edge** with from as function, and to as exit point.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     returns(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * Adds a **return edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
-    returnsQuery(from: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    returnsQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **defines-on-call edge** with from as variable, and to as its definition
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definesOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * 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: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    definesOnCallQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **defined-by-on-call edge** with from as definition, and to as variable.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definedByOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * 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: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    definedByOnCallQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds an **argument edge** with from as function call, and to as argument.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     argument(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * Adds a **argument edge** with a query for the from and/or to vertices.
-     *
      * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
      */
-    argumentQuery(from: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    argumentQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **non-standard evaluation edge** with from as vertex, and to as vertex.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     nse(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * 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: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    nseQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * Adds a **side-effect-on-call edge** with from as vertex, and to as vertex.
-     *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     sideEffectOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
      * 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: FromQueryParam, to: ToQueryParam, data: FlowrAnalysisProvider): Promise<this>;
+    sideEffectOnCallQuery(from: FromQueryParam, to: ToQueryParam, data: ReadonlyFlowrAnalysisProvider): Promise<this>;
     /**
      * explicitly overwrite the root ids of the graph,
      * this is just an easier variant in case you working with a lot of functions this saves you a lot of `false` flags.
      */
     overwriteRootIds(ids: readonly NodeId[]): this;
 }
+/**
+ *
+ */
 export declare function getBuiltInSideEffect(name: string): LinkTo<RegExp> | undefined;
 interface Query {
     query: FlowrSearchLike;

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 */;