com.twitter.finagle.util

Ring

Related Doc: package util

class Ring extends AnyRef

Class Ring implements a hash ring. Given an array mapping indices to positions, the ring supplies the reverse mapping: to which index does a position belong?

Its distinguishing feature is that Ring can pick random positions in a range. (And then map them to their corresponding indices.) Ring can also pick without replacement two elements from a range.

val r = new Ring(Array(1,5,20))
r(0)  == 0
r(1)  == 0
r(2)  == 1
r(5)  == 1
r(6)  == 2
r(20) == 2
r(21) == 0 // Wraps around; it's a ring!
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Ring
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Ring(positions: Array[Int])

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 apply(pos: Int): Int

    Compute the index of the given position.

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  16. def pick(rng: Rng, off: Int, wid: Int): Int

    Pick a position within the given range, described by an offset and width, returning the index of the picked element.

    Pick a position within the given range, described by an offset and width, returning the index of the picked element.

    rng

    The Rng used for picking.

    off

    The offset from which to pick.

    wid

    The width of the range.

  17. def pick2(rng: Rng, off: Int, wid: Int): (Int, Int)

    Pick two elements.

    Pick two elements. They are picked without replacement as long as the offset and width admits it. Zero-width nodes cannot be picked without replacement.

    rng

    The Rng used for picking.

    off

    The offset from which to pick.

    wid

    The width of the range.

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  19. def toString(): String

    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped