org.saddle.locator

Locator

trait Locator[T] extends Serializable

The Locator class provides a mapping from a key to the first location of that key within a corresponding Index containing at least one of that key.

As it provides a representative for a subset of keys in the index, in the language of category theory, this mapping is a section:

Given an array x of type T, which represents a mapping

           f
       {i} => {T}

for i in [0, x.length), Locator provides the associated section

           s
       {T} => {i}

where s(t) = min(i) for any i such that f(i) = t.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Locator
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def contains(key: T): Boolean

    Whether the instance contains the key

    Whether the instance contains the key

    key

    The key to query

  2. abstract def count(key: T): Int

    Return the number of times the key was entered into the map

    Return the number of times the key was entered into the map

    key

    The key to query

  3. abstract def counts(): Array[Int]

    Returns counts associated with the keys in the same order as keys()

  4. abstract def get(key: T): Int

    Should return the first offset corresponding to the provided key, or -1 if none was found.

    Should return the first offset corresponding to the provided key, or -1 if none was found.

    key

    The key to query

  5. abstract def inc(key: T): Int

    Increment the count for a key

    Increment the count for a key

    key

    The key whose count should increment

  6. abstract def keys(): Array[T]

    Return the keys contained in the map in original insertion order

  7. abstract def put(key: T, value: Int): Unit

    Put a new key into the map along with an associated integer value.

    Put a new key into the map along with an associated integer value.

    key

    Key to put into map

    value

    Value to associate with key

  8. abstract def size: Int

    Number of entries in the Locator map

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any