Packages

abstract class NumberSelector extends AnyRef

The base class for all different sorts of number selection policies.

The Arrays called out as method parameters is always an Array of indexes for some other list. The indices in the Array are always the complete range of 0 to n numbers. It is recommended to initialize the Array with the rule array(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.)

Source
NumberSelector.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
OpportunisticSelector, RandomSelector, RandomSequenceSelector, SpecificSelector, StrictInOrderSelector
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NumberSelector
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NumberSelector()

Abstract Value Members

  1. abstract def Get(ary: Array[Int]): Int

    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.

    ary

    the Array of Int numbers from which to draw a new number

    returns

    an Int number

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def Format(ary: Array[Int]): Unit

    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.

    ary

    the Array of Int numbers

  5. def Return(number: Int, ary: Array[Int]): Boolean

    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.
    returnNumber 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.

    number

    the number to be returned

    ary

    the Array of Int numbers to which the number is to be returned

    returns

    true, if this return was successful; false, otherwise

  6. def ReturnIndex: Int
  7. def SelectionIndex: Int
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. var ret: Int

    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.

    Attributes
    protected
  20. var selectionIndex: Int

    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.

    Attributes
    protected
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped