Uses of Class io.github.skenvy.Collatz.FailedSaneParameterCheck (Collatz 1.0.2 API)

Uses of Collatz.FailedSaneParameterCheck in io.github.skenvy

Methods in io.github.skenvy that throw Collatz.FailedSaneParameterCheck
Modifier and Type	Method	Description
`static BigInteger`	Collatz.`function(BigInteger n)`	Returns the output of a single application of the Collatz function.
`static BigInteger`	Collatz.`function(BigInteger n, BigInteger p, BigInteger a, BigInteger b)`	Returns the output of a single application of a Collatz-esque function.
`static Collatz.HailstoneSequence`	Collatz.`hailstoneSequence(BigInteger initialValue, int maxTotalStoppingTime)`	Returns a list of successive values obtained by iterating the Collatz function, until either 1 is reached, or the total amount of iterations exceeds maxTotalStoppingTime.
`static Collatz.HailstoneSequence`	Collatz.`hailstoneSequence(BigInteger initialValue, BigInteger p, BigInteger a, BigInteger b, int maxTotalStoppingTime, boolean totalStoppingTime)`	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.
`static BigInteger[]`	Collatz.`reverseFunction(BigInteger n)`	Returns the output of a single application of the Collatz reverse function.
`static BigInteger[]`	Collatz.`reverseFunction(BigInteger n, BigInteger p, BigInteger a, BigInteger b)`	Returns the output of a single application of a Collatz-esque reverse function.
`static Double`	Collatz.`stoppingTime(BigInteger initialValue)`	Returns the stopping time, the amount of iterations required to reach a value less than the initial value, or null if maxStoppingTime is exceeded.
`static Double`	Collatz.`stoppingTime(BigInteger initialValue, BigInteger p, BigInteger a, BigInteger b, int maxStoppingTime, boolean totalStoppingTime)`	Returns the stopping time, the amount of iterations required to reach a value less than the initial value, or null if maxStoppingTime is exceeded.
`static Collatz.TreeGraph`	Collatz.`treeGraph(BigInteger initialValue, int maxOrbitDistance)`	Returns a directed tree graph of the reverse function values up to a maximum nesting of maxOrbitDistance, with the initialValue as the root.
`static Collatz.TreeGraph`	Collatz.`treeGraph(BigInteger initialValue, int maxOrbitDistance, BigInteger p, BigInteger a, BigInteger b)`	Returns a directed tree graph of the reverse function values up to a maximum nesting of maxOrbitDistance, with the initialValue as the root.

Constructors in io.github.skenvy that throw Collatz.FailedSaneParameterCheck
Constructor	Description
`HailstoneSequence(BigInteger initialValue, BigInteger p, BigInteger a, BigInteger b, int maxTotalStoppingTime, boolean totalStoppingTime)`	Initialise and compute a new Hailstone Sequence.
`TreeGraph(BigInteger nodeValue, int maxOrbitDistance, BigInteger p, BigInteger a, BigInteger b)`	Create a new TreeGraph with the root node defined by the inputs.
`TreeGraphNode(BigInteger nodeValue, int maxOrbitDistance, BigInteger p, BigInteger a, BigInteger b)`	Create an instance of TreeGraphNode which will yield its entire sub-tree of all child nodes.