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.

Annotations
@SerialVersionUID()
Linear Supertypes
Serializable, Serializable, (T) ⇒ Int, Iterable[T], IterableLike[T, Iterable[T]], Equals, GenIterable[T], GenIterableLike[T, Iterable[T]], Traversable[T], GenTraversable[T], GenericTraversableTemplate[T, Iterable], TraversableLike[T, Iterable[T]], GenTraversableLike[T, Iterable[T]], Parallelizable[T, ParIterable[T]], TraversableOnce[T], GenTraversableOnce[T], FilterMonadic[T, Iterable[T]], HasNewBuilder[T, Iterable[T] @scala.annotation.unchecked.uncheckedVariance], AnyRef, Any
Known Subclasses
CompositeIndex, DenseIntIndex, EitherIndex, HashIndex, IsomorphismIndex, MutableIndex, OptionIndex, PairIndex, SynchronizedIndex
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Index
  2. Serializable
  3. Serializable
  4. Function1
  5. Iterable
  6. IterableLike
  7. Equals
  8. GenIterable
  9. GenIterableLike
  10. Traversable
  11. GenTraversable
  12. GenericTraversableTemplate
  13. TraversableLike
  14. GenTraversableLike
  15. Parallelizable
  16. TraversableOnce
  17. GenTraversableOnce
  18. FilterMonadic
  19. HasNewBuilder
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = Iterable[T]
    Attributes
    protected[this]
    Definition Classes
    TraversableLike
  2. class WithFilter extends FilterMonadic[A, Repr]
    Definition Classes
    TraversableLike

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
    IterableLike → GenIterableLike
  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. def ++[B >: T, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  4. def ++:[B >: T, That](that: Traversable[B])(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike
  5. def ++:[B >: T, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike
  6. def /:[B](z: B)(op: (B, T) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  7. def :\[B](z: B)(op: (T, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def addString(b: StringBuilder): StringBuilder
    Definition Classes
    TraversableOnce
  10. def addString(b: StringBuilder, sep: String): StringBuilder
    Definition Classes
    TraversableOnce
  11. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
    Definition Classes
    TraversableOnce
  12. def aggregate[B](z: ⇒ B)(seqop: (B, T) ⇒ B, combop: (B, B) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  13. def andThen[A](g: (Int) ⇒ A): (T) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def canEqual(that: Any): Boolean
    Definition Classes
    IterableLike → Equals
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  17. def collect[B, That](pf: PartialFunction[T, B])(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  18. def collectFirst[B](pf: PartialFunction[T, B]): Option[B]
    Definition Classes
    TraversableOnce
  19. def companion: GenericCompanion[Iterable]
    Definition Classes
    Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate
  20. def compose[A](g: (A) ⇒ T): (A) ⇒ Int
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  21. def contains(t: T): Boolean

    Returns true if this index contains the element t.

  22. def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Unit
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  23. def copyToArray[B >: T](xs: Array[B]): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  24. def copyToArray[B >: T](xs: Array[B], start: Int): Unit
    Definition Classes
    TraversableOnce → GenTraversableOnce
  25. def copyToBuffer[B >: T](dest: Buffer[B]): Unit
    Definition Classes
    TraversableOnce
  26. def count(p: (T) ⇒ Boolean): Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  27. lazy val defaultHashCode: Int
    Attributes
    protected
  28. def drop(n: Int): Iterable[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  29. def dropRight(n: Int): Iterable[T]
    Definition Classes
    IterableLike
  30. def dropWhile(p: (T) ⇒ Boolean): Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(other: Any): Boolean
    Definition Classes
    Index → Equals → AnyRef → Any
  33. def exists(p: (T) ⇒ Boolean): Boolean
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  34. def filter(p: (T) ⇒ Boolean): Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  35. def filterNot(p: (T) ⇒ Boolean): Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  36. def find(p: (T) ⇒ Boolean): Option[T]
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  37. def flatMap[B, That](f: (T) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  38. def flatten[B](implicit asTraversable: (T) ⇒ GenTraversableOnce[B]): Iterable[B]
    Definition Classes
    GenericTraversableTemplate
  39. def fold[A1 >: T](z: A1)(op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  40. def foldLeft[B](z: B)(op: (B, T) ⇒ B): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  41. def foldRight[B](z: B)(op: (T, B) ⇒ B): B
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  42. def forall(p: (T) ⇒ Boolean): Boolean
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  43. def foreach[U](f: (T) ⇒ U): Unit
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
  44. def genericBuilder[B]: Builder[B, Iterable[B]]
    Definition Classes
    GenericTraversableTemplate
  45. def get(i: Int): T

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

  46. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def groupBy[K](f: (T) ⇒ K): Map[K, Iterable[T]]
    Definition Classes
    TraversableLike → GenTraversableLike
  48. def grouped(size: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableLike
  49. def hasDefiniteSize: Boolean
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
  50. def hashCode(): Int
    Definition Classes
    Index → AnyRef → Any
  51. def head: T
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  52. def headOption: Option[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  53. def indexOf(t: T): Int

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

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

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

  55. def init: Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  56. def inits: Iterator[Iterable[T]]
    Definition Classes
    TraversableLike
  57. def isEmpty: Boolean
    Definition Classes
    IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. final def isTraversableAgain: Boolean
    Definition Classes
    TraversableLike → GenTraversableLike → GenTraversableOnce
  60. def last: T
    Definition Classes
    TraversableLike → GenTraversableLike
  61. def lastOption: Option[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  62. def map[B, That](f: (T) ⇒ B)(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  63. def max[B >: T](implicit cmp: Ordering[B]): T
    Definition Classes
    TraversableOnce → GenTraversableOnce
  64. def maxBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T
    Definition Classes
    TraversableOnce → GenTraversableOnce
  65. def min[B >: T](implicit cmp: Ordering[B]): T
    Definition Classes
    TraversableOnce → GenTraversableOnce
  66. def minBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T
    Definition Classes
    TraversableOnce → GenTraversableOnce
  67. def mkString: String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  68. def mkString(sep: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  69. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    TraversableOnce → GenTraversableOnce
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. def newBuilder: Builder[T, Iterable[T]]
    Attributes
    protected[this]
    Definition Classes
    GenericTraversableTemplate → HasNewBuilder
  72. def nonEmpty: Boolean
    Definition Classes
    TraversableOnce → GenTraversableOnce
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. def par: ParIterable[T]
    Definition Classes
    Parallelizable
  76. def parCombiner: Combiner[T, ParIterable[T]]
    Attributes
    protected[this]
    Definition Classes
    TraversableLike → Parallelizable
  77. def partition(p: (T) ⇒ Boolean): (Iterable[T], Iterable[T])
    Definition Classes
    TraversableLike → GenTraversableLike
  78. def product[B >: T](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  79. def reduce[A1 >: T](op: (A1, A1) ⇒ A1): A1
    Definition Classes
    TraversableOnce → GenTraversableOnce
  80. def reduceLeft[B >: T](op: (B, T) ⇒ B): B
    Definition Classes
    TraversableOnce
  81. def reduceLeftOption[B >: T](op: (B, T) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  82. def reduceOption[A1 >: T](op: (A1, A1) ⇒ A1): Option[A1]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  83. def reduceRight[B >: T](op: (T, B) ⇒ B): B
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  84. def reduceRightOption[B >: T](op: (T, B) ⇒ B): Option[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  85. def repr: Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  86. def reversed: List[T]
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  87. def sameElements[B >: T](that: GenIterable[B]): Boolean
    Definition Classes
    IterableLike → GenIterableLike
  88. def scan[B >: T, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  89. def scanLeft[B, That](z: B)(op: (B, T) ⇒ B)(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
  90. def scanRight[B, That](z: B)(op: (T, B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[T], B, That]): That
    Definition Classes
    TraversableLike → GenTraversableLike
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

  91. def seq: Iterable[T]
    Definition Classes
    Iterable → GenIterable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
  92. def size: Int
    Definition Classes
    TraversableOnce → GenTraversableOnce
  93. def sizeHintIfCheap: Int
    Attributes
    protected[scala.collection]
    Definition Classes
    GenTraversableOnce
  94. def slice(from: Int, until: Int): Iterable[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  95. def sliding(size: Int, step: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableLike
  96. def sliding(size: Int): Iterator[Iterable[T]]
    Definition Classes
    IterableLike
  97. def span(p: (T) ⇒ Boolean): (Iterable[T], Iterable[T])
    Definition Classes
    TraversableLike → GenTraversableLike
  98. def splitAt(n: Int): (Iterable[T], Iterable[T])
    Definition Classes
    TraversableLike → GenTraversableLike
  99. def stringPrefix: String
    Definition Classes
    TraversableLike → GenTraversableLike
  100. def sum[B >: T](implicit num: Numeric[B]): B
    Definition Classes
    TraversableOnce → GenTraversableOnce
  101. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  102. def tail: Iterable[T]
    Definition Classes
    TraversableLike → GenTraversableLike
  103. def tails: Iterator[Iterable[T]]
    Definition Classes
    TraversableLike
  104. def take(n: Int): Iterable[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  105. def takeRight(n: Int): Iterable[T]
    Definition Classes
    IterableLike
  106. def takeWhile(p: (T) ⇒ Boolean): Iterable[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableLike
  107. def thisCollection: Iterable[T]
    Attributes
    protected[this]
    Definition Classes
    IterableLike → TraversableLike
  108. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, T, Col[T]]): Col[T]
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
  109. def toArray[B >: T](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  110. def toBuffer[B >: T]: Buffer[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  111. def toCollection(repr: Iterable[T]): Iterable[T]
    Attributes
    protected[this]
    Definition Classes
    IterableLike → TraversableLike
  112. def toIndexedSeq: IndexedSeq[T]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  113. def toIterable: Iterable[T]
    Definition Classes
    IterableLike → TraversableOnce → GenTraversableOnce
  114. def toIterator: Iterator[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  115. def toList: List[T]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  116. def toMap[T, U](implicit ev: <:<[T, (T, U)]): Map[T, U]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  117. def toSeq: Seq[T]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  118. def toSet[B >: T]: Set[B]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  119. def toStream: Stream[T]
    Definition Classes
    IterableLike → TraversableLike → GenTraversableOnce
  120. def toString(): String
    Definition Classes
    Index → Function1 → TraversableLike → AnyRef → Any
  121. def toTraversable: Traversable[T]
    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  122. def toVector: Vector[T]
    Definition Classes
    TraversableOnce → GenTraversableOnce
  123. def transpose[B](implicit asTraversable: (T) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]
    Definition Classes
    GenericTraversableTemplate
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

  124. def unzip[A1, A2](implicit asPair: (T) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])
    Definition Classes
    GenericTraversableTemplate
  125. def unzip3[A1, A2, A3](implicit asTriple: (T) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
    Definition Classes
    GenericTraversableTemplate
  126. def view(from: Int, until: Int): IterableView[T, Iterable[T]]
    Definition Classes
    IterableLike → TraversableLike
  127. def view: IterableView[T, Iterable[T]]
    Definition Classes
    IterableLike → TraversableLike
  128. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  129. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. def withFilter(p: (T) ⇒ Boolean): FilterMonadic[T, Iterable[T]]
    Definition Classes
    TraversableLike → FilterMonadic
  132. def zip[A1 >: T, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[Iterable[T], (A1, B), That]): That
    Definition Classes
    IterableLike → GenIterableLike
  133. def zipAll[B, A1 >: T, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Iterable[T], (A1, B), That]): That
    Definition Classes
    IterableLike → GenIterableLike
  134. def zipWithIndex[A1 >: T, That](implicit bf: CanBuildFrom[Iterable[T], (A1, Int), That]): That
    Definition Classes
    IterableLike → GenIterableLike
  135. def |[U](right: Index[U]): EitherIndex[T, U]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from (T) ⇒ Int

Inherited from Iterable[T]

Inherited from IterableLike[T, Iterable[T]]

Inherited from Equals

Inherited from GenIterable[T]

Inherited from GenIterableLike[T, Iterable[T]]

Inherited from Traversable[T]

Inherited from GenTraversable[T]

Inherited from GenericTraversableTemplate[T, Iterable]

Inherited from TraversableLike[T, Iterable[T]]

Inherited from GenTraversableLike[T, Iterable[T]]

Inherited from Parallelizable[T, ParIterable[T]]

Inherited from TraversableOnce[T]

Inherited from GenTraversableOnce[T]

Inherited from FilterMonadic[T, Iterable[T]]

Inherited from HasNewBuilder[T, Iterable[T] @scala.annotation.unchecked.uncheckedVariance]

Inherited from AnyRef

Inherited from Any

Ungrouped