@skenvy/collatz/lib/cjs/types/TreeGraph.d.ts

Functions related to the Collatz/Syracuse/3N+1 problem, implemented in JavaScript.

import { TreeGraphNode } from './TreeGraphNode.js';
/**
 * Parameterised inputs
 * @remarks
 * Allows non-default (P,a,b); and other options.
 */
export interface CollatzTreeGraphParameters {
    /**
     * The value on which to perform the Collatz-esque function
     */
    initialValue: bigint;
    /**
     * Modulus used to devide n, iff n is equivalent to (0 mod P).
     * @defaultValue 2n
     */
    P?: bigint;
    /**
     * Factor by which to multiply n.
     * @defaultValue 3n
     */
    a?: bigint;
    /**
     * Value to add to the scaled value of n.
     * @defaultValue 1n
     */
    b?: bigint;
    /**
     * Maximum amount of times to iterate the reverse function. There is no
     * natural termination to populating the tree graph, equivalent to the
     * termination of hailstone sequences or stopping time attempts, so this
     * is not an optional argument like maxStoppingTime / maxTotalStoppingTime,
     * as it is the intended target of orbits to obtain, rather than a limit to
     * avoid uncapped computation.
     */
    maxOrbitDistance: number;
}
/**
 * Contains the results of computing the Tree Graph via Collatz.treeGraph(~).
 * Contains the root node of a tree of TreeGraphNode's.
 */
export declare class TreeGraph {
    /** The root node of the tree of TreeGraphNode's. */
    readonly root: TreeGraphNode;
    /**
     * Create a new TreeGraph with the root node defined by the inputs.
     * @param nodeValue - The value for which to find the tree graph node reversal.
     * @param maxOrbitDistance - The maximum distance/orbit/branch length to travel.
     * @param P - Modulus used to devide n, iff n is equivalent to (0 mod P).
     * @param a - Factor by which to multiply n.
     * @param b - Value to add to the scaled value of n.
     * @returns A TreeGraph, a tree with branches traversing the inverse function.
     * @throws FailedSaneParameterCheck
     * Thrown if either P or a are 0.
     */
    constructor(nodeValue: bigint, maxOrbitDistance: number, P: bigint, a: bigint, b: bigint);
}
/**
 * Returns a directed tree graph of the reverse function values up to a maximum
 * nesting of maxOrbitDistance, with the initialValue as the root.
 * @param parameterisedInputs - Allows non-default (P,a,b); and other options.
 * @returns A TreeGraph, a tree with branches traversing the inverse function.
 * @throws FailedSaneParameterCheck
 * Thrown if either P or a are 0.
 */
export declare function treeGraph({ initialValue, maxOrbitDistance, P, a, b }: CollatzTreeGraphParameters): TreeGraph;
//# sourceMappingURL=TreeGraph.d.ts.map