trait Index[T] extends Iterable[T] with (T) => Int with Serializable

Trait that marks an O(1) bidirectional map between Ints (increasing from 0) and T's. This class is used, for example, to efficiently build unique vector space mappings for strings. The methods in this trait do not mutate the underlying index. Use either a MutableIndex or one of the companion object constructor methods to build an index.

Linear Supertypes
Serializable, (T) => Int, Iterable[T], IterableFactoryDefaults[T, Iterable], IterableOps[T, Iterable, Iterable[T]], IterableOnceOps[T, Iterable, Iterable[T]], IterableOnce[T], AnyRef, Any
Known Subclasses
CompositeIndex, DenseIntIndex, EitherIndex, HashIndex, IsomorphismIndex, MutableIndex, OptionIndex, PairIndex
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Index
  2. Serializable
  3. Function1
  4. Iterable
  5. IterableFactoryDefaults
  6. IterableOps
  7. IterableOnceOps
  8. IterableOnce
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply(t: T): Int

    Returns the int id of the given element (0-based) or -1 if not found in the index.

    Returns the int id of the given element (0-based) or -1 if not found in the index. This method never changes the index (even in MutableIndex).

    Definition Classes
    Index → Function1
  2. abstract def iterator: Iterator[T]
    Definition Classes
    IterableOnce
  3. abstract def pairs: Iterator[(T, Int)]

    Returns the indexed items along with their indicies

  4. abstract def unapply(i: Int): Option[T]

    Returns Some(t) if this int corresponds to some object, and None otherwise.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ++[B >: T](suffix: IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def addString(b: StringBuilder): StringBuilder
    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  6. final def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  7. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    IterableOnceOps
  8. def andThen[A](g: (Int) => A): (T) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def className: String
    Attributes
    protected[this]
    Definition Classes
    Iterable
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  12. final def coll: Index.this.type
    Attributes
    protected
    Definition Classes
    Iterable → IterableOps
  13. def collect[B](pf: PartialFunction[T, B]): Iterable[B]
    Definition Classes
    IterableOps → IterableOnceOps
  14. def collectFirst[B](pf: PartialFunction[T, B]): Option[B]
    Definition Classes
    IterableOnceOps
  15. def compose[A](g: (A) => T): (A) => Int
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  16. def concat[B >: T](suffix: IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps
  17. def contains(t: T): Boolean

    Returns true if this index contains the element t.

  18. def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Int
    Definition Classes
    IterableOnceOps
  19. def copyToArray[B >: T](xs: Array[B], start: Int): Int
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
  20. def copyToArray[B >: T](xs: Array[B]): Int
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
  21. def corresponds[B](that: IterableOnce[B])(p: (T, B) => Boolean): Boolean
    Definition Classes
    IterableOnceOps
  22. def count(p: (T) => Boolean): Int
    Definition Classes
    IterableOnceOps
  23. lazy val defaultHashCode: Int
    Attributes
    protected
  24. def drop(n: Int): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  25. def dropRight(n: Int): Iterable[T]
    Definition Classes
    IterableOps
  26. def dropWhile(p: (T) => Boolean): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  27. def empty: Iterable[T]
    Definition Classes
    IterableFactoryDefaults → IterableOps
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(other: Any): Boolean
    Definition Classes
    Index → AnyRef → Any
  30. def exists(p: (T) => Boolean): Boolean
    Definition Classes
    IterableOnceOps
  31. def filter(pred: (T) => Boolean): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  32. def filterNot(pred: (T) => Boolean): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  33. def find(p: (T) => Boolean): Option[T]
    Definition Classes
    IterableOnceOps
  34. def flatMap[B](f: (T) => IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps → IterableOnceOps
  35. def flatten[B](implicit asIterable: (T) => IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps → IterableOnceOps
  36. def fold[A1 >: T](z: A1)(op: (A1, A1) => A1): A1
    Definition Classes
    IterableOnceOps
  37. def foldLeft[B](z: B)(op: (B, T) => B): B
    Definition Classes
    IterableOnceOps
  38. def foldRight[B](z: B)(op: (T, B) => B): B
    Definition Classes
    IterableOnceOps
  39. def forall(p: (T) => Boolean): Boolean
    Definition Classes
    IterableOnceOps
  40. def foreach[U](f: (T) => U): Unit
    Definition Classes
    IterableOnceOps
  41. def fromSpecific(coll: IterableOnce[T]): Iterable[T]
    Attributes
    protected
    Definition Classes
    IterableFactoryDefaults → IterableOps
  42. def get(i: Int): T

    Returns an object at the given position or throws IndexOutOfBoundsException if it's not found.

  43. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  44. def groupBy[K](f: (T) => K): Map[K, Iterable[T]]
    Definition Classes
    IterableOps
  45. def groupMap[K, B](key: (T) => K)(f: (T) => B): Map[K, Iterable[B]]
    Definition Classes
    IterableOps
  46. def groupMapReduce[K, B](key: (T) => K)(f: (T) => B)(reduce: (B, B) => B): Map[K, B]
    Definition Classes
    IterableOps
  47. def grouped(size: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableOps
  48. def hashCode(): Int
    Definition Classes
    Index → AnyRef → Any
  49. def head: T
    Definition Classes
    IterableOps
  50. def headOption: Option[T]
    Definition Classes
    IterableOps
  51. def indexOf(t: T): Int

    Override Iterable's linear-scan indexOf to use our apply method.

  52. def indexOpt(t: T): Option[Int]

    Returns Some(i) if the object has been indexed, or None.

  53. def init: Iterable[T]
    Definition Classes
    IterableOps
  54. def inits: Iterator[Iterable[T]]
    Definition Classes
    IterableOps
  55. def isEmpty: Boolean
    Definition Classes
    IterableOnceOps
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. def isTraversableAgain: Boolean
    Definition Classes
    IterableOps → IterableOnceOps
  58. def iterableFactory: IterableFactory[Iterable]
    Definition Classes
    Iterable → IterableOps
  59. def knownSize: Int
    Definition Classes
    IterableOnce
  60. def last: T
    Definition Classes
    IterableOps
  61. def lastOption: Option[T]
    Definition Classes
    IterableOps
  62. def lazyZip[B](that: Iterable[B]): LazyZip2[T, B, Index.this.type]
    Definition Classes
    Iterable
  63. def map[B](f: (T) => B): Iterable[B]
    Definition Classes
    IterableOps → IterableOnceOps
  64. def max[B >: T](implicit ord: Ordering[B]): T
    Definition Classes
    IterableOnceOps
  65. def maxBy[B](f: (T) => B)(implicit cmp: Ordering[B]): T
    Definition Classes
    IterableOnceOps
  66. def maxByOption[B](f: (T) => B)(implicit cmp: Ordering[B]): Option[T]
    Definition Classes
    IterableOnceOps
  67. def maxOption[B >: T](implicit ord: Ordering[B]): Option[T]
    Definition Classes
    IterableOnceOps
  68. def min[B >: T](implicit ord: Ordering[B]): T
    Definition Classes
    IterableOnceOps
  69. def minBy[B](f: (T) => B)(implicit cmp: Ordering[B]): T
    Definition Classes
    IterableOnceOps
  70. def minByOption[B](f: (T) => B)(implicit cmp: Ordering[B]): Option[T]
    Definition Classes
    IterableOnceOps
  71. def minOption[B >: T](implicit ord: Ordering[B]): Option[T]
    Definition Classes
    IterableOnceOps
  72. final def mkString: String
    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  73. final def mkString(sep: String): String
    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  74. final def mkString(start: String, sep: String, end: String): String
    Definition Classes
    IterableOnceOps
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. def newSpecificBuilder: Builder[T, Iterable[T]]
    Attributes
    protected
    Definition Classes
    IterableFactoryDefaults → IterableOps
  77. def nonEmpty: Boolean
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  80. def partition(p: (T) => Boolean): (Iterable[T], Iterable[T])
    Definition Classes
    IterableOps
  81. def partitionMap[A1, A2](f: (T) => Either[A1, A2]): (Iterable[A1], Iterable[A2])
    Definition Classes
    IterableOps
  82. def product[B >: T](implicit num: Numeric[B]): B
    Definition Classes
    IterableOnceOps
  83. def reduce[B >: T](op: (B, B) => B): B
    Definition Classes
    IterableOnceOps
  84. def reduceLeft[B >: T](op: (B, T) => B): B
    Definition Classes
    IterableOnceOps
  85. def reduceLeftOption[B >: T](op: (B, T) => B): Option[B]
    Definition Classes
    IterableOnceOps
  86. def reduceOption[B >: T](op: (B, B) => B): Option[B]
    Definition Classes
    IterableOnceOps
  87. def reduceRight[B >: T](op: (T, B) => B): B
    Definition Classes
    IterableOnceOps
  88. def reduceRightOption[B >: T](op: (T, B) => B): Option[B]
    Definition Classes
    IterableOnceOps
  89. def reversed: Iterable[T]
    Attributes
    protected
    Definition Classes
    IterableOnceOps
  90. def scan[B >: T](z: B)(op: (B, B) => B): Iterable[B]
    Definition Classes
    IterableOps
  91. def scanLeft[B](z: B)(op: (B, T) => B): Iterable[B]
    Definition Classes
    IterableOps → IterableOnceOps
  92. def scanRight[B](z: B)(op: (T, B) => B): Iterable[B]
    Definition Classes
    IterableOps
  93. def size: Int
    Definition Classes
    IterableOnceOps
  94. def sizeCompare(that: Iterable[_]): Int
    Definition Classes
    IterableOps
  95. def sizeCompare(otherSize: Int): Int
    Definition Classes
    IterableOps
  96. final def sizeIs: SizeCompareOps
    Definition Classes
    IterableOps
    Annotations
    @inline()
  97. def slice(from: Int, until: Int): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  98. def sliding(size: Int, step: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableOps
  99. def sliding(size: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableOps
  100. def span(p: (T) => Boolean): (Iterable[T], Iterable[T])
    Definition Classes
    IterableOps → IterableOnceOps
  101. def splitAt(n: Int): (Iterable[T], Iterable[T])
    Definition Classes
    IterableOps → IterableOnceOps
  102. def stepper[S <: Stepper[_]](implicit shape: StepperShape[T, S]): S
    Definition Classes
    IterableOnce
  103. def stringPrefix: String
    Attributes
    protected[this]
    Definition Classes
    Iterable
    Annotations
    @deprecatedOverriding()
  104. def sum[B >: T](implicit num: Numeric[B]): B
    Definition Classes
    IterableOnceOps
  105. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  106. def tail: Iterable[T]
    Definition Classes
    IterableOps
  107. def tails: Iterator[Iterable[T]]
    Definition Classes
    IterableOps
  108. def take(n: Int): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  109. def takeRight(n: Int): Iterable[T]
    Definition Classes
    IterableOps
  110. def takeWhile(p: (T) => Boolean): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  111. def tapEach[U](f: (T) => U): Iterable[T]
    Definition Classes
    IterableOps → IterableOnceOps
  112. def to[C1](factory: Factory[T, C1]): C1
    Definition Classes
    IterableOnceOps
  113. def toArray[B >: T](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    IterableOnceOps
  114. final def toBuffer[B >: T]: Buffer[B]
    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  115. def toIndexedSeq: IndexedSeq[T]
    Definition Classes
    IterableOnceOps
  116. def toList: List[T]
    Definition Classes
    IterableOnceOps
  117. def toMap[K, V](implicit ev: <:<[T, (K, V)]): Map[K, V]
    Definition Classes
    IterableOnceOps
  118. def toSeq: Seq[T]
    Definition Classes
    IterableOnceOps
  119. def toSet[B >: T]: Set[B]
    Definition Classes
    IterableOnceOps
  120. def toString(): String
    Definition Classes
    Index → Function1 → Iterable → AnyRef → Any
  121. def toVector: Vector[T]
    Definition Classes
    IterableOnceOps
  122. def transpose[B](implicit asIterable: (T) => Iterable[B]): Iterable[Iterable[B]]
    Definition Classes
    IterableOps
  123. def unzip[A1, A2](implicit asPair: (T) => (A1, A2)): (Iterable[A1], Iterable[A2])
    Definition Classes
    IterableOps
  124. def unzip3[A1, A2, A3](implicit asTriple: (T) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
    Definition Classes
    IterableOps
  125. def view: View[T]
    Definition Classes
    IterableOps
  126. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  127. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  128. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. def withFilter(p: (T) => Boolean): WithFilter[T, Iterable]
    Definition Classes
    IterableOps
  130. def zip[B](that: IterableOnce[B]): Iterable[(T, B)]
    Definition Classes
    IterableOps
  131. def zipAll[A1 >: T, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]
    Definition Classes
    IterableOps
  132. def zipWithIndex: Iterable[(T, Int)]
    Definition Classes
    IterableOps → IterableOnceOps
  133. def |[U](right: Index[U]): EitherIndex[T, U]

Deprecated Value Members

  1. def ++:[B >: T](that: IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable

  2. final def /:[B](z: B)(op: (B, T) => B): B
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldLeft instead of /:

  3. final def :\[B](z: B)(op: (T, B) => B): B
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldRight instead of :\

  4. def aggregate[B](z: => B)(seqop: (B, T) => B, combop: (B, B) => B): B
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) aggregate is not relevant for sequential collections. Use foldLeft(z)(seqop) instead.

  5. def companion: IterableFactory[Iterable]
    Definition Classes
    IterableOps
    Annotations
    @deprecated @deprecatedOverriding() @inline()
    Deprecated

    (Since version 2.13.0) Use iterableFactory instead

  6. final def copyToBuffer[B >: T](dest: Buffer[B]): Unit
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use dest ++= coll instead

  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  8. def hasDefiniteSize: Boolean
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

  9. final def repr: Iterable[T]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside

  10. def seq: Index.this.type
    Definition Classes
    Iterable
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Iterable.seq always returns the iterable itself

  11. final def toIterable: Index.this.type
    Definition Classes
    Iterable → IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  12. final def toIterator: Iterator[T]
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator instead of .toIterator

  13. final def toStream: Stream[T]
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .to(LazyList) instead of .toStream

  14. final def toTraversable: Traversable[T]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  15. def view(from: Int, until: Int): View[T]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)

Inherited from Serializable

Inherited from (T) => Int

Inherited from Iterable[T]

Inherited from IterableFactoryDefaults[T, Iterable]

Inherited from IterableOps[T, Iterable, Iterable[T]]

Inherited from IterableOnceOps[T, Iterable, Iterable[T]]

Inherited from IterableOnce[T]

Inherited from AnyRef

Inherited from Any

Ungrouped