@eagleoutice/flowr/abstract-interpretation/domains/abstract-domain.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

import type { Bottom, Lattice, Top } from './lattice';
/**
 * The default limit of inferred constraints in {@link AbstractDomain|AbstractDomains}.
 */
export declare const DEFAULT_INFERENCE_LIMIT = 50;
/**
 * An abstract domain as complete lattice with a widening operator, narrowing operator, concretization function, and abstraction function.
 * @template Concrete - Type of an concrete element of the concrete domain for the abstract domain
 * @template Abstract - Type of an abstract element of the abstract domain representing possible elements (may exclude `Top` and `Bot`)
 * @template Top      - Type of the Top element of the abstract domain representing all possible elements (defaults to {@link Top})
 * @template Bot      - Type of the Bottom element of the abstract domain representing no possible elements (defaults to {@link Bottom})
 * @template Lift     - Type of the abstract elements of the abstract domain (defaults to `Abstract` or `Top` or `Bot`)
 */
export interface AbstractDomain<Concrete, Abstract, Top = typeof Top, Bot = typeof Bottom, Lift extends Abstract | Top | Bot = Abstract | Top | Bot> extends Lattice<Abstract, Top, Bot, Lift> {
    /**
     * Widens the current abstract value with another abstract value as a sound over-approximation of the join (least upper bound) for fixpoint iteration acceleration.
     */
    widen(other: AbstractDomain<Concrete, Abstract, Top, Bot>): AbstractDomain<Concrete, Abstract, Top, Bot>;
    /**
     * Narrows the current abstract value with another abstract value as a sound over-approximation of the meet (greatest lower bound) to refine the value after widening.
     */
    narrow(other: AbstractDomain<Concrete, Abstract, Top, Bot>): AbstractDomain<Concrete, Abstract, Top, Bot>;
    /**
     * Maps the current abstract value into a set of possible concrete values as concretization function of the abstract domain.
     * The result should be `Top` if the number of concrete values would reach the `limit` or the resulting set would have infinite many elements.
     */
    concretize(limit?: number): ReadonlySet<Concrete> | typeof Top;
    /**
     * Maps a set of possible concrete values into an abstract value as abstraction function of the abstract domain (should additionally be provided as static function).
     */
    abstract(concrete: ReadonlySet<Concrete> | typeof Top): AbstractDomain<Concrete, Abstract, Top, Bot>;
}
/**
 * The type of the concrete domain of an abstract domain.
 * @template Domain - The abstract domain to get the concrete domain type for
 */
export type ConcreteDomain<Domain extends AbstractDomain<unknown, unknown, unknown, unknown>> = Domain extends AbstractDomain<infer Concrete, unknown, unknown, unknown> ? Concrete : never;
/**
 * The type of the Top element (greatest element) of an abstract domain.
 * @template Domain - The abstract domain to get the Top element type for
 */
export type AbstractDomainTop<Domain extends AbstractDomain<unknown, unknown, unknown, unknown>> = Domain extends AbstractDomain<unknown, unknown, infer Top, unknown> ? Top : never;
/**
 * The type of the Bottom element (least element) of an abstract domain.
 * @template Domain - The abstract domain to get the Bottom element type for
 */
export type AbstractDomainBottom<Domain extends AbstractDomain<unknown, unknown, unknown, unknown>> = Domain extends AbstractDomain<unknown, unknown, unknown, infer Bot> ? Bot : never;
/**
 * The type of the abstract values of an abstract domain (including the Top and Bottom element).
 * @template Domain - The abstract domain to get the abstract value type for
 */
export type AbstractDomainValue<Domain extends AbstractDomain<unknown, unknown, unknown, unknown>> = Domain extends AbstractDomain<unknown, infer Value, infer Top, infer Bot> ? Value | Top | Bot : never;
/**
 * Converts an element of an abstract domain into a string.
 */
export declare function domainElementToString(value: AbstractDomain<unknown, unknown, unknown, unknown> | unknown): string;