net.psforever.objects.guid.selector
NumberSelector
Related Doc:
package selector
Accept a provided pool and select the next number.
The main requirement for valid implementation of a Get selector is atomicity.
Accept a provided pool and select the next number.
The main requirement for valid implementation of a Get selector is atomicity.
While Get could be written to run again for every failure, this should not be anticipated.
A success means a "success."
A failure means that no "success" would be possible no matter how many times it might be run under the current conditions.
The aforementioned conditions may change depending on the nature of the specific selector;
but, the previous requirement should not be violated.
Get is under no obligation to not modify its parameter Array.
In fact, it should do this by default to provide additional feedback of its process.
Pass a copy if data mutation is a concern.
the Array of Int numbers from which to draw a new number
an Int number
Accept the indexing pool from which numbers are selected and returned.
Accept the indexing pool from which numbers are selected and returned.
Correct its format to suit the current NumberSelector algorithms.
Moving all of the invalid negative-ones (-1) to the left of the current valid indices works for most selectors.
The selectionIndex is set to the first valid number available from the left.
The ret index is set to index zero.
the Array of Int numbers
Give a number back to a specific collection following the principles of this selector.
By default, a simple policy for returning numbers has been provided.
Give a number back to a specific collection following the principles of this selector.
By default, a simple policy for returning numbers has been provided.
This will not be sufficient for all selection actions that can be implemented so override where necessary.
Return is under no obligation to leave its parameter Array unmodified.
In fact, it should modify it by default to provide additional feedback of its process.
Pass a copy if data mutation is a concern.
the number to be returned
the Array of Int numbers to which the number is to be returned
true, if this return was successful; false, otherwise
The index for the selector when performing a number return action, then modified for the "next" index.
The index for the selector when performing a number return action, then modified for the "next" index.
The index for the selector when performing a number selection action, then modified to the "next" index.
The index for the selector when performing a number selection action, then modified to the "next" index.
The base class for all different sorts of number selection policies.
The
Arrays called out as method parameters is always anArrayof indexes for some other list. The indices in theArrayare always the complete range of 0 tonnumbers. It is recommended to initialize theArraywith the rulearray(number) = number. When they need to be flagged as "invalid" in some way, use some consistent system of negative numbers. (Recommendation: unless doing something fancy, just use -1.)