@eagleoutice/flowr 2.6.1 → 2.6.2

package/dataflow/eval/resolve/resolve.js

@@ -23,7 +23,6 @@ const scalar_consatnts_1 = require("../values/scalar/scalar-consatnts");
  *
  * This function converts an RNode to its Value, but also recursively resolves
  * aliases and vectors (in case of a vector).
- *
  * @param a       - Ast node to resolve
  * @param resolve - Variable resolve mode
  * @param env     - Environment to use
@@ -75,7 +74,6 @@ function resolveNode(resolve, a, env, graph, map) {
  *
  * This function resolves a vector function call `c` to a {@link ValueVector}
  * by recursively resolving the values of the arguments by calling {@link resolveIdToValue}
- *
  * @param resolve - Variable resolve mode
  * @param node    - Node of the vector function to resolve
  * @param env     - Environment to use
@@ -97,7 +95,6 @@ function resolveAsVector(resolve, node, environment, graph, idMap) {
  *
  * This function resolves a binary sequence operator `:` to a {@link ValueVector} of {@link ValueNumber}s
  * by recursively resolving the values of the arguments by calling {@link resolveIdToValue}
- *
  * @param resolve  - Variable resolve mode
  * @param operator - Node of the sequence operator to resolve
  * @param env      - Environment to use
@@ -125,7 +122,6 @@ function resolveAsSeq(resolve, operator, environment, graph, idMap) {
  *
  * This function resolves a unary plus operator `+` to a {@link ValueNumber} or {@link ValueVector} of ValueNumbers
  * by recursively resolving the values of the arguments by calling {@link resolveIdToValue}
- *
  * @param resolve  - Variable resolve mode
  * @param operator - Node of the plus operator to resolve
  * @param env      - Environment to use
@@ -154,7 +150,6 @@ function resolveAsPlus(resolve, operator, environment, graph, idMap) {
  *
  * This function resolves a unary minus operator `-` to a {@link ValueNumber} or {@link ValueVector} of ValueNumbers
  * by recursively resolving the values of the arguments by calling {@link resolveIdToValue}
- *
  * @param resolve  - Variable resolve mode
  * @param operator - Node of the minus operator to resolve
  * @param env      - Environment to use

package/dataflow/eval/values/general.d.ts

@@ -1,6 +1,5 @@
 import type { RNodeWithParent } from '../../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { Lift, Value, ValueSet } from './r-value';
-import { Bottom, Top } from './r-value';
+import { type Lift, type Value, type ValueSet, Bottom, Top } from './r-value';
 /**
  * Takes n potentially lifted ops and returns `Top` or `Bottom` if any is `Top` or `Bottom`.
  */
@@ -8,7 +7,6 @@ export declare function bottomTopGuard(...a: Lift<unknown>[]): typeof Top | type
 /**
  * Returns a value set, if a is not bottom or top, otherwise undefined.
  * Useful when working with values returned by {@link resolveIdToValue}
- *
  * @param a - value set to check
  * @returns value set if a is not top or bottom
  */

package/dataflow/eval/values/general.js

@@ -23,7 +23,6 @@ function bottomTopGuard(...a) {
 /**
  * Returns a value set, if a is not bottom or top, otherwise undefined.
  * Useful when working with values returned by {@link resolveIdToValue}
- *
  * @param a - value set to check
  * @returns value set if a is not top or bottom
  */

package/dataflow/eval/values/intervals/interval-constants.d.ts

@@ -1,4 +1,10 @@
 import type { RNumberValue } from '../../../../r-bridge/lang-4.x/convert-values';
-import type { Lift, ValueInterval, ValueNumber } from '../r-value';
+import { type Lift, type ValueInterval, type ValueNumber } from '../r-value';
+/**
+ *
+ */
 export declare function intervalFrom(start: RNumberValue | number, end?: number | RNumberValue, startInclusive?: boolean, endInclusive?: boolean): ValueInterval;
+/**
+ *
+ */
 export declare function intervalFromValues(start: Lift<ValueNumber>, end?: Lift<ValueNumber<Lift<RNumberValue>>>, startInclusive?: boolean, endInclusive?: boolean): ValueInterval;

package/dataflow/eval/values/intervals/interval-constants.js

@@ -4,6 +4,9 @@ exports.intervalFrom = intervalFrom;
 exports.intervalFromValues = intervalFromValues;
 const r_value_1 = require("../r-value");
 const scalar_consatnts_1 = require("../scalar/scalar-consatnts");
+/**
+ *
+ */
 function intervalFrom(start, end = start, startInclusive = true, endInclusive = true) {
     return intervalFromValues(typeof start === 'number' ? (0, scalar_consatnts_1.getScalarFromInteger)(start) : (0, scalar_consatnts_1.liftScalar)(start), typeof end === 'number' ? (0, scalar_consatnts_1.getScalarFromInteger)(end) : (0, scalar_consatnts_1.liftScalar)(end), startInclusive, endInclusive);
 }
@@ -15,6 +18,9 @@ function shiftNum(v) {
         return v;
     }
 }
+/**
+ *
+ */
 function intervalFromValues(start, end = start, startInclusive = true, endInclusive = true) {
     return {
         type: 'interval',

package/dataflow/eval/values/logical/logical-constants.d.ts

@@ -1,4 +1,7 @@
-import type { Lift, TernaryLogical, ValueLogical } from '../r-value';
+import { type Lift, type TernaryLogical, type ValueLogical } from '../r-value';
+/**
+ *
+ */
 export declare function liftLogical(log: Lift<TernaryLogical>): ValueLogical;
 export declare const ValueLogicalTrue: ValueLogical;
 export declare const ValueLogicalFalse: ValueLogical;

package/dataflow/eval/values/logical/logical-constants.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValueLogicalBot = exports.ValueLogicalTop = exports.ValueLogicalMaybe = exports.ValueLogicalFalse = exports.ValueLogicalTrue = void 0;
 exports.liftLogical = liftLogical;
 const r_value_1 = require("../r-value");
+/**
+ *
+ */
 function liftLogical(log) {
     if (log === r_value_1.Top) {
         return exports.ValueLogicalTop;

package/dataflow/eval/values/r-value.d.ts

@@ -53,9 +53,21 @@ export type ValueType<V> = V extends {
     type: infer T;
 } ? T : never;
 export type ValueTypes = ValueType<Value>;
+/**
+ *
+ */
 export declare function typeOfValue<V extends Value>(value: V): V['type'];
+/** Checks whether the given value is the top value */
 export declare function isTop<V extends Lift<unknown>>(value: V): value is typeof Top;
+/** Checks whether the given value is the bottom value */
 export declare function isBottom<V extends Lift<unknown>>(value: V): value is typeof Bottom;
+/** Checks whether the given value is a proper value (neither top nor bottom) */
 export declare function isValue<V extends Lift<unknown>>(value: V): value is Unlift<V>;
+/**
+ * Treat a value as unlifted value, throws if it is top or bottom.
+ */
 export declare function asValue<V extends Lift<unknown>>(value: V): Unlift<V>;
+/**
+ *
+ */
 export declare function stringifyValue(value: Lift<Value>): string;

package/dataflow/eval/values/r-value.js

@@ -10,20 +10,29 @@ exports.stringifyValue = stringifyValue;
 const assert_1 = require("../../../util/assert");
 exports.Top = { type: Symbol('⊤') };
 exports.Bottom = { type: Symbol('⊥') };
+/**
+ *
+ */
 function typeOfValue(value) {
     return value.type;
 }
+/** Checks whether the given value is the top value */
 // @ts-expect-error -- this is a save cast
 function isTop(value) {
     return value === exports.Top;
 }
+/** Checks whether the given value is the bottom value */
 // @ts-expect-error -- this is a save cast
 function isBottom(value) {
     return value === exports.Bottom;
 }
+/** Checks whether the given value is a proper value (neither top nor bottom) */
 function isValue(value) {
     return !isTop(value) && !isBottom(value);
 }
+/**
+ * Treat a value as unlifted value, throws if it is top or bottom.
+ */
 function asValue(value) {
     (0, assert_1.guard)(isValue(value), 'Expected a value, but got a top or bottom value');
     return value;
@@ -60,6 +69,9 @@ function renderString(value) {
         return `${quote}${JSON.stringify(value.str).slice(1, -1)}${quote}`;
     }
 }
+/**
+ *
+ */
 function stringifyValue(value) {
     return tryStringifyBoTop(value, v => {
         const t = v.type;

package/dataflow/eval/values/scalar/scalar-consatnts.d.ts

@@ -1,6 +1,12 @@
-import type { Lift, ValueNumber } from '../r-value';
+import { type Lift, type ValueNumber } from '../r-value';
 import type { RNumberValue } from '../../../../r-bridge/lang-4.x/convert-values';
+/**
+ *
+ */
 export declare function getScalarFromInteger(num: number, markedAsInt?: boolean, complexNumber?: boolean): ValueNumber<RNumberValue>;
+/**
+ *
+ */
 export declare function liftScalar(value: Lift<RNumberValue>): ValueNumber;
 export declare const ValueIntegerOne: ValueNumber<RNumberValue>;
 export declare const ValueNumberComplexOne: ValueNumber<RNumberValue>;

package/dataflow/eval/values/scalar/scalar-consatnts.js

@@ -4,6 +4,9 @@ exports.ValueIntegerBottom = exports.ValueIntegerTop = exports.ValueNumberOneHal
 exports.getScalarFromInteger = getScalarFromInteger;
 exports.liftScalar = liftScalar;
 const r_value_1 = require("../r-value");
+/**
+ *
+ */
 function getScalarFromInteger(num, markedAsInt = Number.isInteger(num), complexNumber = false) {
     return {
         type: 'number',
@@ -14,6 +17,9 @@ function getScalarFromInteger(num, markedAsInt = Number.isInteger(num), complexN
         }
     };
 }
+/**
+ *
+ */
 function liftScalar(value) {
     return {
         type: 'number',

package/dataflow/eval/values/sets/set-constants.d.ts

@@ -1,6 +1,11 @@
-import type { Lift, Value, ValueSet } from '../r-value';
-import { Top } from '../r-value';
+import { type Lift, type Value, type ValueSet, Top } from '../r-value';
+/**
+ *
+ */
 export declare function setFrom<V extends Value[]>(...elements: V): Lift<ValueSet<Value[]>>;
+/**
+ *
+ */
 export declare function isSet<V extends Value>(element: V): boolean;
 export declare const ValueEmptySet: Lift<ValueSet<Value[]>>;
 export declare const ValueSetTop: ValueSet<typeof Top>;

package/dataflow/eval/values/sets/set-constants.js

@@ -10,6 +10,9 @@ function flattenSetElements(s) {
         return e.type === 'set' ? flattenSetElements(e.elements) : e;
     });
 }
+/**
+ *
+ */
 function setFrom(...elements) {
     const vals = elements.flatMap(e => {
         return e.type === 'set' ? flattenSetElements(e.elements) : e;
@@ -19,6 +22,9 @@ function setFrom(...elements) {
         elements: vals
     };
 }
+/**
+ *
+ */
 function isSet(element) {
     return element.type === 'set';
 }

package/dataflow/eval/values/string/string-constants.d.ts

@@ -1,7 +1,16 @@
 import type { RStringValue } from '../../../../r-bridge/lang-4.x/convert-values';
-import type { Lift, Value, ValueString } from '../r-value';
+import { type Lift, type Value, type ValueString } from '../r-value';
+/**
+ *
+ */
 export declare function stringFrom(str: RStringValue | string): ValueString;
+/**
+ *
+ */
 export declare function liftString(str: Lift<RStringValue>): ValueString;
+/**
+ *
+ */
 export declare function collectStrings(a: Value[], withQuotes?: boolean): string[] | undefined;
 export declare const ValueEmptyString: ValueString<Lift<RStringValue>>;
 export declare const ValueStringTop: ValueString<Lift<RStringValue>>;

package/dataflow/eval/values/string/string-constants.js

@@ -6,6 +6,9 @@ exports.liftString = liftString;
 exports.collectStrings = collectStrings;
 const general_1 = require("../general");
 const r_value_1 = require("../r-value");
+/**
+ *
+ */
 function stringFrom(str) {
     return {
         type: 'string',
@@ -15,12 +18,18 @@ function stringFrom(str) {
         } : str,
     };
 }
+/**
+ *
+ */
 function liftString(str) {
     return {
         type: 'string',
         value: str
     };
 }
+/**
+ *
+ */
 function collectStrings(a, withQuotes = false) {
     if ((0, general_1.bottomTopGuard)(a)) {
         return undefined;

package/dataflow/eval/values/vectors/vector-constants.d.ts

@@ -1,4 +1,4 @@
-import type { Lift, Value, ValueVector } from '../r-value';
+import { type Lift, type Value, type ValueVector } from '../r-value';
 /**
  * Creates an abstract vector from abstract values
  * @param elements - elements that the vector should contain

package/dataflow/extractor.d.ts

@@ -1,5 +1,5 @@
 import type { DataflowInformation } from './info';
-import type { DataflowProcessors } from './processor';
+import { type DataflowProcessors } from './processor';
 import type { NormalizedAst, ParentInformation } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { RParseRequests } from '../r-bridge/retriever';
 import type { KnownParserType, Parser } from '../r-bridge/parser';

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;