Index (Collatz 1.0.2 API)

C D E F G H I K M R S T V Z
All Classes All Packages

C

Collatz - Class in io.github.skenvy: Provides the basic functionality to interact with the Collatz conjecture.
Collatz() - Constructor for class io.github.skenvy.Collatz
Collatz.FailedSaneParameterCheck - Exception in io.github.skenvy: Thrown when either P, the modulus, or a, the multiplicand, are zero.
Collatz.HailstoneSequence - Class in io.github.skenvy: Contains the results of computing a hailstone sequence via Collatz.hailstoneSequence(~).
Collatz.SaneParameterErrMsg - Enum in io.github.skenvy: Error message constants, to be used as input to the FailedSaneParameterCheck.
Collatz.SequenceState - Enum in io.github.skenvy: SequenceState for Cycle Control: Descriptive flags to indicate when some event occurs in the hailstone sequences or tree graph reversal, when set to verbose, or stopping time check.
Collatz.TreeGraph - Class in io.github.skenvy: Contains the results of computing the Tree Graph via Collatz.treeGraph(~).
Collatz.TreeGraphNode - Class in io.github.skenvy: Nodes that form a "tree graph", structured as a tree, with their own node's value, as well as references to either possible child node, where a node can only ever have two children, as there are only ever two reverse values.
CYCLE_INIT - io.github.skenvy.Collatz.SequenceState: A Hailstone and TreeGraph sequence state that indicates the first occurence of a value that subsequently forms a cycle.
CYCLE_LENGTH - io.github.skenvy.Collatz.SequenceState: A Hailstone and TreeGraph sequence state that indicates the last occurence of a value that has already formed a cycle.

D

DEFAULT_A - Static variable in class io.github.skenvy.Collatz: Default value for a, the input's multiplicand.
DEFAULT_B - Static variable in class io.github.skenvy.Collatz: Default value for b, the value added to the multiplied value.
DEFAULT_P - Static variable in class io.github.skenvy.Collatz: Default value for P, the modulus condition.

E

equals(Object) - Method in class io.github.skenvy.Collatz.TreeGraph: The equality between TreeGraph's is determined by the equality check on subtrees.
equals(Object) - Method in class io.github.skenvy.Collatz.TreeGraphNode: The equality between TreeGraphNodes is determined exclusively by the node's value, independent of the child nodes or sequence states that would be relevant to the node's status relative to the tree.

F

FailedSaneParameterCheck(Collatz.SaneParameterErrMsg) - Constructor for exception io.github.skenvy.Collatz.FailedSaneParameterCheck: Construct a FailedSaneParameterCheck with a message associated with the provided enum.
function(BigInteger) - Static method in class io.github.skenvy.Collatz: Returns the output of a single application of the Collatz function.
function(BigInteger, BigInteger, BigInteger, BigInteger) - Static method in class io.github.skenvy.Collatz: Returns the output of a single application of a Collatz-esque function.

G

getErrorMessage() - Method in enum io.github.skenvy.Collatz.SaneParameterErrMsg: Retrieve the error message associated with the enum.
getLabel() - Method in enum io.github.skenvy.Collatz.SequenceState: Retrieve the sequence state string associated with the enum.

H

hailstoneSequence(BigInteger, int) - Static method in class io.github.skenvy.Collatz: 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.
hailstoneSequence(BigInteger, BigInteger, BigInteger, BigInteger, int, boolean) - Static method in class io.github.skenvy.Collatz: 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.
HailstoneSequence(BigInteger, BigInteger, BigInteger, BigInteger, int, boolean) - Constructor for class io.github.skenvy.Collatz.HailstoneSequence: Initialise and compute a new Hailstone Sequence.
hashCode() - Method in class io.github.skenvy.Collatz.TreeGraph: The hashCode of a TreeGraph is determined by the hash of the root node.
hashCode() - Method in class io.github.skenvy.Collatz.TreeGraphNode: The hashCode of a TreeGraphNode is determined by the node's value, the child nodes and sequence state.

I

io.github.skenvy - package io.github.skenvy

K

KNOWN_CYCLES - Static variable in class io.github.skenvy.Collatz: The four known cycles for the standard parameterisation.

M

MAX_STOP_OUT_OF_BOUNDS - io.github.skenvy.Collatz.SequenceState: A Hailstone and TreeGraph sequence state that indicates the sequence or traversal has executed some imposed 'maximum' amount of times.

R

reverseFunction(BigInteger) - Static method in class io.github.skenvy.Collatz: Returns the output of a single application of the Collatz reverse function.
reverseFunction(BigInteger, BigInteger, BigInteger, BigInteger) - Static method in class io.github.skenvy.Collatz: Returns the output of a single application of a Collatz-esque reverse function.

S

SANE_PARAMS_A - io.github.skenvy.Collatz.SaneParameterErrMsg: Message to print in the FailedSaneParameterCheck if a, the multiplicand, is zero.
SANE_PARAMS_P - io.github.skenvy.Collatz.SaneParameterErrMsg: Message to print in the FailedSaneParameterCheck if P, the modulus, is zero.
STOPPING_TIME - io.github.skenvy.Collatz.SequenceState: A Hailstone sequence state that indicates the stopping time, a value less than the initial, has been reached.
stoppingTime(BigInteger) - Static method in class io.github.skenvy.Collatz: Returns the stopping time, the amount of iterations required to reach a value less than the initial value, or null if maxStoppingTime is exceeded.
stoppingTime(BigInteger, BigInteger, BigInteger, BigInteger, int, boolean) - Static method in class io.github.skenvy.Collatz: Returns the stopping time, the amount of iterations required to reach a value less than the initial value, or null if maxStoppingTime is exceeded.
subTreeEquals(Collatz.TreeGraphNode) - Method in class io.github.skenvy.Collatz.TreeGraphNode: A much stricter equality check than the equals(Object obj) override.

T

TOTAL_STOPPING_TIME - io.github.skenvy.Collatz.SequenceState: A Hailstone sequence state that indicates the total stopping time, a value of 1, has been reached.
treeGraph(BigInteger, int) - Static method in class io.github.skenvy.Collatz: Returns a directed tree graph of the reverse function values up to a maximum nesting of maxOrbitDistance, with the initialValue as the root.
treeGraph(BigInteger, int, BigInteger, BigInteger, BigInteger) - Static method in class io.github.skenvy.Collatz: Returns a directed tree graph of the reverse function values up to a maximum nesting of maxOrbitDistance, with the initialValue as the root.
TreeGraph(Collatz.TreeGraphNode) - Constructor for class io.github.skenvy.Collatz.TreeGraph: Create a new TreeGraph by directly passing it the root node.
TreeGraph(BigInteger, int, BigInteger, BigInteger, BigInteger) - Constructor for class io.github.skenvy.Collatz.TreeGraph: Create a new TreeGraph with the root node defined by the inputs.
TreeGraphNode(BigInteger, int, BigInteger, BigInteger, BigInteger) - Constructor for class io.github.skenvy.Collatz.TreeGraphNode: Create an instance of TreeGraphNode which will yield its entire sub-tree of all child nodes.
TreeGraphNode(BigInteger, Collatz.SequenceState, Collatz.TreeGraphNode, Collatz.TreeGraphNode) - Constructor for class io.github.skenvy.Collatz.TreeGraphNode: Create an instance of TreeGraphNode by directly passing it the values required to instantiate, intended to be used in testing by manually creating trees in reverse, by passing expected child nodes to their parents until the entire expected tree is created.

V

valueOf(String) - Static method in enum io.github.skenvy.Collatz.SaneParameterErrMsg: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.skenvy.Collatz.SequenceState: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.skenvy.Collatz.SaneParameterErrMsg: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.skenvy.Collatz.SequenceState: Returns an array containing the constants of this enum type, in the order they are declared.
VERIFIED_MAXIMUM - Static variable in class io.github.skenvy.Collatz: The current value up to which the standard parameterisation has been verified.
VERIFIED_MINIMUM - Static variable in class io.github.skenvy.Collatz: The current value down to which the standard parameterisation has been verified.

Z

ZERO_STOP - io.github.skenvy.Collatz.SequenceState: A Hailstone sequence state that indicates the sequence terminated by reaching "0", a special type of "stopping time".

C D E F G H I K M R S T V Z
All Classes All Packages