Variable default

Type declaration

• HailstoneSequence: typeof HailstoneSequence

• TreeGraph: typeof TreeGraph

• TreeGraphNode: typeof TreeGraphNode

• collatzFunction: ((parameterisedInputs) => bigint)

  • • (parameterisedInputs): bigint

    • Parameterised Collatz Function

      Parameters

      • parameterisedInputs: CollatzFunctionParameters

        Allows non-default (P,a,b)

      Returns bigint

      the output of a single application of a Collatz-esque function.

      Throws

      FailedSaneParameterCheck Thrown if either P or a are 0.

• hailstoneSequence: ((parameterisedInputs) => HailstoneSequence)

  • • (parameterisedInputs): HailstoneSequence

    • Returns a list of successive values obtained by iterating a Collatz-esque function, until either 1 is reached, or the total amount of iterations exceeds maxTotalStoppingTime, unless totalStoppingTime is False, which will terminate the hailstone at the "stopping time" value, i.e. the first value less than the initial value. While the sequence has the capability to determine that it has encountered a cycle, the cycle from "1" wont be attempted or reported as part of a cycle, regardless of default or custom parameterisation, as "1" is considered a "total stop".

      Parameters

      • parameterisedInputs: CollatzHailstoneParameters

        Allows non-default (P,a,b); and other options.

      Returns HailstoneSequence

      A HailstoneSequence, a set of values that form the hailstone sequence.

      Throws

      FailedSaneParameterCheck Thrown if either P or a are 0.

• reverseFunction: ((parameterisedInputs) => bigint[])

  • • (parameterisedInputs): bigint[]

    • Parameterised Collatz Inverse Function

      Parameters

      • parameterisedInputs: CollatzFunctionParameters

        Allows non-default (P,a,b)

      Returns bigint[]

      the output of a single application of a Collatz-esque reverse function.

      Throws

      FailedSaneParameterCheck Thrown if either P or a are 0.

• stoppingTime: ((parameterisedInputs) => number | null)

  • • (parameterisedInputs): number | null

    • Returns the stopping time, the amount of iterations required to reach a value less than the initial value, or null if maxStoppingTime is exceeded. Alternatively, if totalStoppingTime is True, then it will instead count the amount of iterations to reach 1. If the sequence does not stop, but instead ends in a cycle, the result will be (Double.POSITIVE_INFINITY). If (P,a,b) are such that it is possible to get stuck on zero, the result will be the negative of what would otherwise be the "total stopping time" to reach 1, where 0 is considered a "total stop" that should not occur as it does form a cycle of length 1.

      Parameters

      • parameterisedInputs: CollatzStoppingTimeParameters

        Allows non-default (P,a,b); and other options.

      Returns number | null

      the stopping time, or, in a special case, infinity, null or a negative.

• treeGraph: ((parameterisedInputs) => TreeGraph)

  • • (parameterisedInputs): TreeGraph

    • Returns a directed tree graph of the reverse function values up to a maximum nesting of maxOrbitDistance, with the initialValue as the root.

      Parameters

      • parameterisedInputs: CollatzTreeGraphParameters

        Allows non-default (P,a,b); and other options.

      Returns TreeGraph

      A TreeGraph, a tree with branches traversing the inverse function.

      Throws

      FailedSaneParameterCheck Thrown if either P or a are 0.