scala.collection.immutable.Range

class Range extends AbstractSeq[Int] with IndexedSeq[Int] with CustomParallelizable[Int, ParRange] with Serializable

The Range class represents integer values in range [start;end) with non-zero step value step . It’s a special case of an indexed sequence. For example:

val r1 = 0 until 10
val r2 = r1.start until r1.end by r1.step + 1
println(r2.length) // = 5

Ranges that contain more than Int.MaxValue elements can be created, but these overfull ranges have only limited capabilities. Any method that could require a collection of over Int.MaxValue length to be created, or could be asked to index beyond Int.MaxValue elements will throw an exception. Overfull ranges can safely be reduced in size by changing the step size (e.g. by 3 ) or taking/dropping elements. contains , equals , and access to the ends of the range ( head , last , tail , init ) are also permitted on overfull ranges.

• Annotations
  • @ SerialVersionUID () @ deprecatedInheritance (message =…, since = “2.11.0”)
• Source
  • Range.scala - Blame
  • Range.scala - History
• Version
  • 2.8
• Since
  • 2.5
• See also
  • “Scala’s Collection Library overview” section on Ranges for more information.

Type Members

class Elements extends AbstractIterator[A] with BufferedIterator[A] with Serializable

The class of the iterator returned by the iterator method. multiple take , drop , and slice operations on this iterator are bunched together for better efficiency.

• Attributes
  • protected
• Definition Classes
  • IndexedSeqLike
• Annotations
  • @ SerialVersionUID ()

type Self = IndexedSeq[Int]

The type implementing this traversable

• Attributes
  • protected[this]
• Definition Classes
  • TraversableLike

class WithFilter extends FilterMonadic[A, Repr]

A class supporting filtered operations. Instances of this class are returned by method withFilter .

• Definition Classes
  • TraversableLike

Value Members From scala.Function1

def compose[A](g: (A) ⇒ Int): (A) ⇒ Int

Composes two instances of Function1 in a new Function1, with this function applied last.

• A
  • the type to which function g can be applied
• g
  • a function A => T1
• returns
  • a new function f such that f(x) == apply(g(x))
• Definition Classes
  • Function1
• Annotations
  • @ unspecialized ()

(defined at scala.Function1)

Value Members From scala.PartialFunction

def andThen[C](k: (Int) ⇒ C): PartialFunction[Int, C]

Composes this partial function with a transformation function that gets applied to results of this partial function.

• C
  • the result type of the transformation function.
• k
  • the transformation function
• returns
  • a partial function with the same domain as this partial function, which maps arguments x to k(this(x)) .
• Definition Classes
  • PartialFunction → Function1

(defined at scala.PartialFunction)

def applyOrElse[A1 <: Int, B1 >: Int](x: A1, default: (A1) ⇒ B1): B1

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Note that expression pf.applyOrElse(x, default) is equivalent to

if(pf isDefinedAt x) pf(x) else default(x)

except that applyOrElse method can be implemented more efficiently. For all partial function literals the compiler generates an applyOrElse implementation which avoids double evaluation of pattern matchers and guards. This makes applyOrElse the basis for the efficient implementation for many operations and scenarios, such as:

• combining partial functions into orElse / andThen chains does not lead to excessive apply / isDefinedAt evaluation
• lift and unlift do not evaluate source functions twice on each invocation
• runWith allows efficient imperative-style combining of partial functions with conditionally applied actions

For non-literal partial function classes with nontrivial isDefinedAt method it is recommended to override applyOrElse with custom implementation that avoids double isDefinedAt evaluation. This may result in better performance and more predictable behavior w.r.t. side effects.

• x
  • the function argument
• default
  • the fallback function
• returns
  • the result of this function or fallback function application.
• Definition Classes
  • PartialFunction
• Since
  • 2.10

(defined at scala.PartialFunction)

def lift: (Int) ⇒ Option[Int]

Turns this partial function into a plain function returning an Option result.

• returns
  • a function that takes an argument x to Some(this(x)) if this is defined for x , and to None otherwise.
• Definition Classes
  • PartialFunction
• See also
  • Function.unlift

(defined at scala.PartialFunction)

def orElse[A1 <: Int, B1 >: Int](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

• A1
  • the argument type of the fallback function
• B1
  • the result type of the fallback function
• that
  • the fallback function
• returns
  • a partial function which has as domain the union of the domains of this partial function and that . The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.
• Definition Classes
  • PartialFunction

(defined at scala.PartialFunction)

def runWith[U](action: (Int) ⇒ U): (Int) ⇒ Boolean

Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

Note that expression pf.runWith(action)(x) is equivalent to

if(pf isDefinedAt x) { action(pf(x)); true } else false

except that runWith is implemented via applyOrElse and thus potentially more efficient. Using runWith avoids double evaluation of pattern matchers and guards for partial function literals.

• action
  • the action function
• returns
  • a function which maps arguments x to isDefinedAt(x) . The resulting function runs action(this(x)) where this is defined.
• Definition Classes
  • PartialFunction
• Since
  • 2.10
• See also
  • applyOrElse .

(defined at scala.PartialFunction)

Value Members From scala.collection.CustomParallelizable

def parCombiner: Combiner[Int, ParRange]

The default par implementation uses the combiner provided by this method to create a new parallel collection.

• returns
  • a combiner for the parallel collection of type ParRepr
• Attributes
  • protected[this]
• Definition Classes
  • CustomParallelizable → Parallelizable

(defined at scala.collection.CustomParallelizable)

Value Members From scala.collection.GenSeqLike

def indexOf[B >: Int](elem: B): Int

[use case]

Finds index of first occurrence of some value in this range.

• elem
  • the element value to search for.
• returns
  • the index of the first element of this range that is equal (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def indexOf[B >: Int](elem: B, from: Int): Int

[use case]

Finds index of first occurrence of some value in this range after or at some start index.

• elem
  • the element value to search for.
• from
  • the start index
• returns
  • the index >= from of the first element of this range that is equal (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def indexWhere(p: (Int) ⇒ Boolean): Int

Finds index of first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the index of the first element of this general sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def isDefinedAt(idx: Int): Boolean

Tests whether this general sequence contains given index.

The implementations of methods apply and isDefinedAt turn a Seq[A] into a PartialFunction[Int, A] .

• idx
  • the index to test
• returns
  • true if this general sequence contains an element at position idx , false otherwise.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def lastIndexOf[B >: Int](elem: B): Int

[use case]

Finds index of last occurrence of some value in this range.

• elem
  • the element value to search for.
• returns
  • the index of the last element of this range that is equal (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def lastIndexOf[B >: Int](elem: B, end: Int): Int

[use case]

Finds index of last occurrence of some value in this range before or at a given end index.

• elem
  • the element value to search for.
• end
  • the end index.
• returns
  • the index <= end of the last element of this range that is equal (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def lastIndexWhere(p: (Int) ⇒ Boolean): Int

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the index of the last element of this general sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def prefixLength(p: (Int) ⇒ Boolean): Int

Returns the length of the longest prefix whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the length of the longest prefix of this general sequence such that every element of the segment satisfies the predicate p .
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def startsWith[B](that: GenSeq[B]): Boolean

Tests whether this general sequence starts with the given sequence.

• that
  • the sequence to test
• returns
  • true if this collection has that as a prefix, false otherwise.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

Value Members From scala.collection.IndexedSeqLike

def iterator: Iterator[Int]

Creates a new iterator over all elements contained in this iterable object.

• returns
  • the new iterator
• Definition Classes
  • IndexedSeqLike → IterableLike → GenIterableLike

(defined at scala.collection.IndexedSeqLike)

def thisCollection: collection.IndexedSeq[Int]

The underlying collection seen as an instance of IndexedSeq . By default this is implemented as the current collection object itself, but this can be overridden.

• Attributes
  • protected[this]
• Definition Classes
  • IndexedSeqLike → SeqLike → IterableLike → TraversableLike

(defined at scala.collection.IndexedSeqLike)

def toBuffer[A1 >: Int]: Buffer[A1]

Uses the contents of this sequence to create a new mutable buffer.

• returns
  • a buffer containing all elements of this sequence.
• Definition Classes
  • IndexedSeqLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqLike)

def toCollection(repr: IndexedSeq[Int]): collection.IndexedSeq[Int]

A conversion from collections of type Repr to IndexedSeq objects. By default this is implemented as just a cast, but this can be overridden.

• Attributes
  • protected[this]
• Definition Classes
  • IndexedSeqLike → SeqLike → IterableLike → TraversableLike

(defined at scala.collection.IndexedSeqLike)

Value Members From scala.collection.IterableLike

def canEqual(that: Any): Boolean

Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

• that
  • The object with which this iterable collection should be compared
• returns
  • true , if this iterable collection can possibly equal that , false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
• Definition Classes
  • IterableLike → Equals

(defined at scala.collection.IterableLike)

def copyToArray[B >: Int](xs: Array[B], start: Int, len: Int): Unit

[use case]

Copies the elements of this range to an array. Fills the given array xs with at most len elements of this range, starting at position start . Copying will stop once either the end of the current range is reached, or the end of the target array is reached, or len elements have been copied.

• xs
  • the array to fill.
• start
  • the starting index.
• len
  • the maximal number of elements to copy.
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def exists(p: (Int) ⇒ Boolean): Boolean

Tests whether a predicate holds for at least one element of this iterable collection.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • false if this iterable collection is empty, otherwise true if the given predicate p holds for some of the elements of this iterable collection, otherwise false
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def find(p: (Int) ⇒ Boolean): Option[Int]

Finds the first element of the iterable collection satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• p
  • the predicate used to test elements.
• returns
  • an option value containing the first element in the iterable collection that satisfies p , or None if none exists.
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def foldRight[B](z: B)(op: (Int, B) ⇒ B): B

Applies a binary operator to all elements of this iterable collection and a start value, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• z
  • the start value.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this iterable collection, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))
    

where `x1, ..., xn` are the elements of this iterable collection. Returns
 `z` if this iterable collection is empty.

• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def forall(p: (Int) ⇒ Boolean): Boolean

Tests whether a predicate holds for all elements of this iterable collection.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • true if this iterable collection is empty or the given predicate p holds for all elements of this iterable collection, otherwise false .
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def grouped(size: Int): Iterator[IndexedSeq[Int]]

Partitions elements in fixed size iterable collections.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections of size size , except the last will be less than size size if the elements don’t divide evenly.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method grouped

(defined at scala.collection.IterableLike)

def reduceRight[B >: Int](op: (Int, B) ⇒ B): B

Applies a binary operator to all elements of this iterable collection, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this iterable collection, going right to left:

    op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
    

where `x1, ..., xn` are the elements of this iterable collection.

• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this iterable collection is empty.

(defined at scala.collection.IterableLike)

def sameElements[B >: Int](that: GenIterable[B]): Boolean

[use case]

Checks if the other iterable collection contains the same elements in the same order as this range.

• that
  • the collection to compare with.
• returns
  • true , if both collections contain the same elements in the same order, false otherwise.
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

def sliding(size: Int): Iterator[IndexedSeq[Int]]

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.) “Sliding window” step is 1 by default.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections of size size , except the last and the only element will be truncated if there are fewer elements than size.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def sliding(size: Int, step: Int): Iterator[IndexedSeq[Int]]

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)

• size
  • the number of elements per group
• step
  • the distance between the first elements of successive groups
• returns
  • An iterator producing iterable collections of size size , except the last and the only element will be truncated if there are fewer elements than size.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def toIterator: Iterator[Int]

Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator .

Note: will not terminate for infinite-sized collections.

• returns
  • an Iterator containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.IterableLike)

def toStream: Stream[Int]

Converts this iterable collection to a stream.

• returns
  • a stream containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce

(defined at scala.collection.IterableLike)

def zipAll[B, A1 >: Int, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[IndexedSeq[Int], (A1, B), That]): That

[use case]

Returns a range formed from this range and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

• B
  • the type of the second half of the returned pairs
• that
  • The iterable providing the second half of each result pair
• thisElem
  • the element to be used to fill up the result if this range is shorter than that .
• thatElem
  • the element to be used to fill up the result if that is shorter than this range.
• returns
  • a new range containing pairs consisting of corresponding elements of this range and that . The length of the returned collection is the maximum of the lengths of this range and that . If this range is shorter than that , thisElem values are used to pad the result. If that is shorter than this range, thatElem values are used to pad the result.
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

def zipWithIndex[A1 >: Int, That](implicit bf: CanBuildFrom[IndexedSeq[Int], (A1, Int), That]): That

[use case]

Zips this range with its indices.

• returns
  • A new range containing pairs consisting of all elements of this range paired with their index. Indices start at 0 .
• Definition Classes
  • IterableLike → GenIterableLike

Example:

List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))

(defined at scala.collection.IterableLike)

def zip[A1 >: Int, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], (A1, B), That]): That

[use case]

Returns a range formed from this range and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

• B
  • the type of the second half of the returned pairs
• that
  • The iterable providing the second half of each result pair
• returns
  • a new range containing pairs consisting of corresponding elements of this range and that . The length of the returned collection is the minimum of the lengths of this range and that .
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

Value Members From scala.collection.SeqLike

def +:[B >: Int, That](elem: B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

A copy of the range with an element prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Also, the original range is not modified, so you will want to capture the result.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)

• elem
  • the prepended element
• returns
  • a new range consisting of elem followed by all elements of this range.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def :+[B >: Int, That](elem: B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

A copy of this range with an element appended.

A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Example:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)

• elem
  • the appended element
• returns
  • a new range consisting of all elements of this range followed by elem .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def combinations(n: Int): Iterator[IndexedSeq[Int]]

Iterates over combinations. A combination of length n is a subsequence of the original sequence, with the elements taken in order. Thus, "xy" and "yy" are both length-2 combinations of "xyy" , but "yx" is not. If there is more than one way to generate the same subsequence, only one will be returned.

For example, "xyyy" has three different ways to generate "xy" depending on whether the first, second, or third "y" is selected. However, since all are identical, only one will be chosen. Which of the three will be taken is an implementation detail that is not defined.

• returns
  • An Iterator which traverses the possible n-element combinations of this sequence.
• Definition Classes
  • SeqLike

Example:

"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)

(defined at scala.collection.SeqLike)

def containsSlice[B](that: GenSeq[B]): Boolean

Tests whether this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • true if this sequence contains a slice with the same elements as that , otherwise false .
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def contains[A1 >: Int](elem: A1): Boolean

Tests whether this sequence contains a given value as an element.

Note: may not terminate for infinite-sized collections.

• elem
  • the element to test.
• returns
  • true if this sequence has an element that is equal (as determined by == ) to elem , false otherwise.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def corresponds[B](that: GenSeq[B])(p: (Int, B) ⇒ Boolean): Boolean

Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate.

• B
  • the type of the elements of that
• that
  • the other sequence
• p
  • the test predicate, which relates elements from both sequences
• returns
  • true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this sequence and y of that , otherwise false .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def diff[B >: Int](that: GenSeq[B]): IndexedSeq[Int]

[use case]

Computes the multiset difference between this range and another sequence.

• that
  • the sequence of elements to remove
• returns
  • a new range which contains all elements of this range except some of occurrences of elements that also appear in that . If an element value x appears n times in that , then the first n occurrences of x will not form part of the result, but any following occurrences will.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def distinct: IndexedSeq[Int]

Builds a new sequence from this sequence without any duplicate elements.

Note: will not terminate for infinite-sized collections.

• returns
  • A new sequence which contains the first occurrence of every element of this sequence.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def endsWith[B](that: GenSeq[B]): Boolean

Tests whether this sequence ends with the given sequence.

Note: will not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • true if this sequence has that as a suffix, false otherwise.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def indexOfSlice[B >: Int](that: GenSeq[B]): Int

Finds first index where this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • the first index such that the elements of this sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def indexOfSlice[B >: Int](that: GenSeq[B], from: Int): Int

Finds first index after or at a start index where this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• from
  • the start index
• returns
  • the first index >= from such that the elements of this sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def indexWhere(p: (Int) ⇒ Boolean, from: Int): Int

Finds index of the first element satisfying some predicate after or at some start index.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• from
  • the start index
• returns
  • the index >= from of the first element of this sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def indices: Range

Produces the range of all indices of this sequence.

• returns
  • a Range value from 0 to one less than the length of this sequence.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def intersect[B >: Int](that: GenSeq[B]): IndexedSeq[Int]

[use case]

Computes the multiset intersection between this range and another sequence.

• that
  • the sequence of elements to intersect with.
• returns
  • a new range which contains all elements of this range which also appear in that . If an element value x appears n times in that , then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def lastIndexOfSlice[B >: Int](that: GenSeq[B]): Int

Finds last index where this sequence contains a given sequence as a slice.

Note: will not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • the last index such that the elements of this sequence starting a this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def lastIndexOfSlice[B >: Int](that: GenSeq[B], end: Int): Int

Finds last index before or at a given end index where this sequence contains a given sequence as a slice.

• that
  • the sequence to test
• end
  • the end index
• returns
  • the last index <= end such that the elements of this sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def lastIndexWhere(p: (Int) ⇒ Boolean, end: Int): Int

Finds index of last element satisfying some predicate before or at given end index.

• p
  • the predicate used to test elements.
• returns
  • the index <= end of the last element of this sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def lengthCompare(len: Int): Int

Compares the length of this sequence to a test value.

• len
  • the test value that gets compared with the length.
• returns
  • A value x where

    x <  0       if this.length <  len
    x == 0       if this.length == len
    x >  0       if this.length >  len
    

The method as implemented here does not call `length` directly; its running
time is `O(length min len)` instead of `O(length)` . The method should be
overwritten if computing `length` is cheap.

• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def padTo[B >: Int, That](len: Int, elem: B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

A copy of this range with an element value appended until a given target length is reached.

• len
  • the target length
• elem
  • the padding value
• returns
  • a new range consisting of all elements of this range followed by the minimal number of occurrences of elem so that the resulting range has a length of at least len .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def patch[B >: Int, That](from: Int, patch: GenSeq[B], replaced: Int)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Produces a new range where a slice of elements in this range is replaced by another sequence.

• from
  • the index of the first replaced element
• replaced
  • the number of elements to drop in the original range
• returns
  • a new range consisting of all elements of this range except that replaced elements starting from from are replaced by patch .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def permutations: Iterator[IndexedSeq[Int]]

Iterates over distinct permutations.

• returns
  • An Iterator which traverses the distinct permutations of this sequence.
• Definition Classes
  • SeqLike

Example:

"abb".permutations = Iterator(abb, bab, bba)

(defined at scala.collection.SeqLike)

def reverseIterator: Iterator[Int]

An iterator yielding elements in reversed order.

Note: will not terminate for infinite-sized collections.

Note: xs.reverseIterator is the same as xs.reverse.iterator but might be more efficient.

• returns
  • an iterator yielding the elements of this sequence in reversed order
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def reverseMap[B, That](f: (Int) ⇒ B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Builds a new collection by applying a function to all elements of this range and collecting the results in reversed order.

Note: xs.reverseMap(f) is the same as xs.reverse.map(f) but might be more efficient.

• B
  • the element type of the returned collection.
• f
  • the function to apply to each element.
• returns
  • a new range resulting from applying the given function f to each element of this range and collecting the results in reversed order.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def segmentLength(p: (Int) ⇒ Boolean, from: Int): Int

Computes length of longest segment whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• from
  • the index where the search starts.
• returns
  • the length of the longest segment of this sequence starting from index from such that every element of the segment satisfies the predicate p .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def sortBy[B](f: (Int) ⇒ B)(implicit ord: math.Ordering[B]): IndexedSeq[Int]

Sorts this Seq according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

• B
  • the target type of the transformation f , and the type where the ordering ord is defined.
• f
  • the transformation function mapping elements to some other domain B .
• ord
  • the ordering assumed on domain B .
• returns
  • a sequence consisting of the elements of this sequence sorted according to the ordering where x < y if ord.lt(f(x), f(y)) .
• Definition Classes
  • SeqLike
• See also
  • scala.math.Ordering Note: will not terminate for infinite-sized collections.

Example:

val words = "The quick brown fox jumped over the lazy dog".split(' ')
// this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
words.sortBy(x => (x.length, x.head))
res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)

(defined at scala.collection.SeqLike)

def sortWith(lt: (Int, Int) ⇒ Boolean): IndexedSeq[Int]

Sorts this sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

The sort is stable. That is, elements that are equal (as determined by lt ) appear in the same order in the sorted sequence as in the original.

• lt
  • the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
• returns
  • a sequence consisting of the elements of this sequence sorted according to the comparison function lt .
• Definition Classes
  • SeqLike

Example:

List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
List("Bob", "John", "Steve", "Tom")

(defined at scala.collection.SeqLike)

def sorted[B >: Int](implicit ord: math.Ordering[B]): IndexedSeq[Int]

Sorts this sequence according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by lt ) appear in the same order in the sorted sequence as in the original.

• ord
  • the ordering to be used to compare elements.
• returns
  • a sequence consisting of the elements of this sequence sorted according to the ordering ord .
• Definition Classes
  • SeqLike
• See also
  • scala.math.Ordering

(defined at scala.collection.SeqLike)

def startsWith[B](that: GenSeq[B], offset: Int): Boolean

Tests whether this sequence contains the given sequence at a given index.

Note : If the both the receiver object this and the argument that are infinite sequences this method may not terminate.

• that
  • the sequence to test
• offset
  • the index where the sequence is searched.
• returns
  • true if the sequence that is contained in this sequence at index offset , otherwise false .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def union[B >: Int, That](that: GenSeq[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Produces a new sequence which contains all elements of this range and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys .

Another way to express this is that xs union ys computes the order-preserving multi-set union of xs and ys . union is hence a counter-part of diff and intersect which also work on multi-sets.

• that
  • the sequence to add.
• returns
  • a new range which contains all elements of this range followed by all elements of that .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def updated[B >: Int, That](index: Int, elem: B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

A copy of this range with one single replaced element.

• index
  • the position of the replacement
• elem
  • the replacing element
• returns
  • a copy of this range with the element at position index replaced by elem .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def view(from: Int, until: Int): SeqView[Int, IndexedSeq[Int]]

Creates a non-strict view of a slice of this sequence.

Note: the difference between view and slice is that view produces a view of the current sequence, whereas slice produces a new sequence.

Note: view(from, to) is equivalent to view.slice(from, to)

• from
  • the index of the first element of the view
• until
  • the index of the element following the view
• returns
  • a non-strict view of a slice of this sequence, starting at index from and extending up to (but not including) index until .
• Definition Classes
  • SeqLike → IterableLike → TraversableLike

(defined at scala.collection.SeqLike)

def view: SeqView[Int, IndexedSeq[Int]]

Creates a non-strict view of this sequence.

• returns
  • a non-strict view of this sequence.
• Definition Classes
  • SeqLike → IterableLike → TraversableLike

(defined at scala.collection.SeqLike)

Value Members From scala.collection.TraversableLike

def ++:[B >: Int, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

As with ++ , returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

• B
  • the element type of the returned collection.
• That
  • the class of the returned collection. Where possible, That is the same class as the current collection class Repr , but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.
• that
  • the traversable to append.
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • a new collection of type That which contains all elements of this traversable collection followed by all elements of that .
• Definition Classes
  • TraversableLike

(defined at scala.collection.TraversableLike)

def ++:[B >: Int, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

As with ++ , returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

• B
  • the element type of the returned collection.
• that
  • the traversable to append.
• returns
  • a new range which contains all elements of this range followed by all elements of that .
• Definition Classes
  • TraversableLike

(defined at scala.collection.TraversableLike)

def ++[B >: Int, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Returns a new range containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the range is the most specific superclass encompassing the element types of the two operands.

Example:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = List(2)
b: List[Int] = List(2)

scala> val c = a ++ b
c: List[Int] = List(1, 2)

scala> val d = List('a')
d: List[Char] = List(a)

scala> val e = c ++ d
e: List[AnyVal] = List(1, 2, a)

• B
  • the element type of the returned collection.
• that
  • the traversable to append.
• returns
  • a new range which contains all elements of this range followed by all elements of that .
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def collect[B, That](pf: PartialFunction[Int, B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Builds a new collection by applying a partial function to all elements of this range on which the function is defined.

• B
  • the element type of the returned collection.
• pf
  • the partial function which filters and maps the range.
• returns
  • a new range resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def filter(p: (Int) ⇒ Boolean): IndexedSeq[Int]

Selects all elements of this traversable collection which satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • a new traversable collection consisting of all elements of this traversable collection that satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def filterNot(p: (Int) ⇒ Boolean): IndexedSeq[Int]

Selects all elements of this traversable collection which do not satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def flatMap[B, That](f: (Int) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Builds a new collection by applying a function to all elements of this range and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of range. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

• B
  • the element type of the returned collection.
• f
  • the function to apply to each element.
• returns
  • a new range resulting from applying the given collection-valued function f to each element of this range and concatenating the results.
• Definition Classes
  • TraversableLike → GenTraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

def groupBy[K](f: (Int) ⇒ K): Map[K, IndexedSeq[Int]]

Partitions this traversable collection into a map of traversable collections according to some discriminator function.

Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.

• K
  • the type of keys returned by the discriminator function.
• f
  • the discriminator function.
• returns
  • A map from keys to traversable collections such that the following invariant holds:

    (xs groupBy f)(k) = xs filter (x => f(x) == k)
    

That is, every key `k` is bound to a traversable collection of those
elements `x` for which `f(x)` equals `k` .

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def headOption: Option[Int]

Optionally selects the first element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• returns
  • the first element of this traversable collection if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def inits: Iterator[IndexedSeq[Int]]

Iterates over the inits of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of init .

• returns
  • an iterator over all the inits of this traversable collection
• Definition Classes
  • TraversableLike

Example:

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

(defined at scala.collection.TraversableLike)

def lastOption: Option[Int]

Optionally selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• returns
  • the last element of this traversable collection$ if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def map[B, That](f: (Int) ⇒ B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

[use case]

Builds a new collection by applying a function to all elements of this range.

• B
  • the element type of the returned collection.
• f
  • the function to apply to each element.
• returns
  • a new range resulting from applying the given function f to each element of this range and collecting the results.
• Definition Classes
  • TraversableLike → GenTraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

def partition(p: (Int) ⇒ Boolean): (IndexedSeq[Int], IndexedSeq[Int])

Partitions this traversable collection in two traversable collections according to a predicate.

• p
  • the predicate on which to partition.
• returns
  • a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate p and the second traversable collection consists of all elements that don’t. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def repr: IndexedSeq[Int]

The collection of type traversable collection underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanLeft[B, That](z: B)(op: (B, Int) ⇒ B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

Produces a collection containing cumulative results of applying the operator going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• B
  • the type of the elements in the resulting collection
• That
  • the actual type of the resulting collection
• z
  • the initial value
• op
  • the binary operator applied to the intermediate result and the element
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • collection with intermediate results
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanRight[B, That](z: B)(op: (Int, B) ⇒ B)(implicit bf: CanBuildFrom[IndexedSeq[Int], B, That]): That

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Example:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)

• B
  • the type of the elements in the resulting collection
• That
  • the actual type of the resulting collection
• z
  • the initial value
• op
  • the binary operator applied to the intermediate result and the element
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • collection with intermediate results
• 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.

(defined at scala.collection.TraversableLike)

def scan[B >: Int, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[IndexedSeq[Int], B, That]): That

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

• B
  • element type of the resulting collection
• That
  • type of the resulting collection
• z
  • neutral element for the operator op
• op
  • the associative operator for the scan
• cbf
  • combiner factory which provides a combiner
• returns
  • a new traversable collection containing the prefix scan of the elements in this traversable collection
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def tails: Iterator[IndexedSeq[Int]]

Iterates over the tails of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of tail .

• returns
  • an iterator over all the tails of this traversable collection
• Definition Classes
  • TraversableLike

Example:

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

(defined at scala.collection.TraversableLike)

def toTraversable: collection.Traversable[Int]

Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

Note: will not terminate for infinite-sized collections.

• returns
  • a Traversable containing all elements of this traversable collection.
• Definition Classes
  • TraversableLike → TraversableOnce → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.TraversableLike)

def withFilter(p: (Int) ⇒ Boolean): FilterMonadic[Int, IndexedSeq[Int]]

Creates a non-strict filter of this traversable collection.

Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map , flatMap , foreach , and withFilter operations.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• p
  • the predicate used to test elements.
• returns
  • an object of class WithFilter , which supports map , flatMap , foreach , and withFilter operations. All these operations apply to those elements of this traversable collection which satisfy the predicate p .
• Definition Classes
  • TraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

Value Members From scala.collection.TraversableOnce

def /:[B](z: B)(op: (B, Int) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

Note: /: is alternate syntax for foldLeft ; z /: xs is the same as xs foldLeft z .

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• z
  • the start value.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:

    op(...op(op(z, x_1), x_2), ..., x_n)
    

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def :\[B](z: B)(op: (Int, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.

Note: :\ is alternate syntax for foldRight ; xs :\ z is the same as xs foldRight z .

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15

• B
  • the result type of the binary operator.
• z
  • the start value
• op
  • the binary operator
• returns
  • the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))
    

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder): StringBuilder

Appends all elements of this traversable or iterator to a string builder. The written text consists of the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator without any separator string.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234

• b
  • the string builder to which elements are appended.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator, separated by the string sep .

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

• b
  • the string builder to which elements are appended.
• sep
  • the separator string.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end . Inside, the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

• b
  • the string builder to which elements are appended.
• start
  • the starting string.
• sep
  • the separator string.
• end
  • the ending string.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def aggregate[B](z: ⇒ B)(seqop: (B, Int) ⇒ B, combop: (B, B) ⇒ B): B

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce . It is similar to foldLeft in that it doesn’t require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop , starting with z (like foldLeft ). Those intermediate results are then combined by using combop (like fold ). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

• B
  • the type of accumulated results
• z
  • the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation) and may be evaluated more than once
• seqop
  • an operator used to accumulate results within a partition
• combop
  • an associative operator used to combine results from different partitions
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def collectFirst[B](pf: PartialFunction[Int, B]): Option[B]

Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• pf
  • the partial function
• returns
  • an option value containing pf applied to the first value for which it is defined, or None if none exists.
• Definition Classes
  • TraversableOnce

Example:

Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

(defined at scala.collection.TraversableOnce)

def copyToArray[B >: Int](xs: Array[B]): Unit

[use case]

Copies the elements of this range to an array. Fills the given array xs with values of this range. Copying will stop once either the end of the current range is reached, or the end of the target array is reached.

• xs
  • the array to fill.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def copyToArray[B >: Int](xs: Array[B], start: Int): Unit

[use case]

Copies the elements of this range to an array. Fills the given array xs with values of this range, beginning at index start . Copying will stop once either the end of the current range is reached, or the end of the target array is reached.

• xs
  • the array to fill.
• start
  • the starting index.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def copyToBuffer[B >: Int](dest: Buffer[B]): Unit

Copies all elements of this traversable or iterator to a buffer.

Note: will not terminate for infinite-sized collections.

• dest
  • The buffer to which elements are copied.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def count(p: (Int) ⇒ Boolean): Int

Counts the number of elements in the traversable or iterator which satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • the number of elements satisfying the predicate p .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def foldLeft[B](z: B)(op: (B, Int) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• z
  • the start value.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:

    op(...op(z, x_1), x_2, ..., x_n)
    

where `x1, ..., xn` are the elements of this traversable or iterator.
Returns `z` if this traversable or iterator is empty.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def fold[A1 >: Int](z: A1)(op: (A1, A1) ⇒ A1): A1

Folds the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Note: will not terminate for infinite-sized collections.

• A1
  • a type parameter for the binary operator, a supertype of A .
• z
  • a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication).
• op
  • a binary operator that must be associative.
• returns
  • the result of applying the fold operator op between all the elements and z , or z if this traversable or iterator is empty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def maxBy[B](f: (Int) ⇒ B)(implicit cmp: Ordering[B]): Int

[use case]

Finds the first element which yields the largest value measured by function f.

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this range with the largest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def minBy[B](f: (Int) ⇒ B)(implicit cmp: Ordering[B]): Int

[use case]

Finds the first element which yields the smallest value measured by function f.

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this range with the smallest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def mkString(sep: String): String

Displays all elements of this traversable or iterator in a string using a separator string.

• sep
  • the separator string.
• returns
  • a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

List(1, 2, 3).mkString("|") = "1|2|3"

(defined at scala.collection.TraversableOnce)

def mkString(start: String, sep: String, end: String): String

Displays all elements of this traversable or iterator in a string using start, end, and separator strings.

• start
  • the starting string.
• sep
  • the separator string.
• end
  • the ending string.
• returns
  • a string representation of this traversable or iterator. The resulting string begins with the string start and ends with the string end . Inside, the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

(defined at scala.collection.TraversableOnce)

def reduceLeftOption[B >: Int](op: (B, Int) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceLeft(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduceLeft[B >: Int](op: (B, Int) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this traversable or iterator, going left to right:

    op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
    

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this traversable or iterator is empty.

(defined at scala.collection.TraversableOnce)

def reduceOption[A1 >: Int](op: (A1, A1) ⇒ A1): Option[A1]

Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

• A1
  • A type parameter for the binary operator, a supertype of A .
• op
  • A binary operator that must be associative.
• returns
  • An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduceRightOption[B >: Int](op: (Int, B) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceRight(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduce[A1 >: Int](op: (A1, A1) ⇒ A1): A1

Reduces the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

• A1
  • A type parameter for the binary operator, a supertype of A .
• op
  • A binary operator that must be associative.
• returns
  • The result of applying reduce operator op between all the elements if the traversable or iterator is nonempty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this traversable or iterator is empty.

(defined at scala.collection.TraversableOnce)

def reversed: scala.List[Int]

• Attributes
  • protected[this]
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def toList: scala.List[Int]

Converts this traversable or iterator to a list.

Note: will not terminate for infinite-sized collections.

• returns
  • a list containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toMap[T, U](implicit ev: <:<[Int, (T, U)]): Map[T, U]

[use case]

Converts this range to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

• returns
  • a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this range.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toSet[B >: Int]: Set[B]

Converts this traversable or iterator to a set.

Note: will not terminate for infinite-sized collections.

• returns
  • a set containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toVector: scala.Vector[Int]

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

• returns
  • a vector containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

Value Members From scala.collection.generic.GenericTraversableTemplate

def flatten[B](implicit asTraversable: (Int) ⇒ GenTraversableOnce[B]): IndexedSeq[B]

[use case]

Converts this range of traversable collections into a range formed by the elements of these traversable collections.

The resulting collection’s type will be guided by the static type of range. For example:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)

• B
  • the type of the elements of each traversable collection.
• returns
  • a new range resulting from concatenating all element ranges.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def genericBuilder[B]: Builder[B, IndexedSeq[B]]

The generic builder that builds instances of Traversable at arbitrary element types.

• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def newBuilder: Builder[Int, IndexedSeq[Int]]

The builder that builds instances of type Traversable[A]

• Attributes
  • protected[this]
• Definition Classes
  • GenericTraversableTemplate → HasNewBuilder

(defined at scala.collection.generic.GenericTraversableTemplate)

def transpose[B](implicit asTraversable: (Int) ⇒ GenTraversableOnce[B]): IndexedSeq[IndexedSeq[B]]

Transposes this collection of traversable collections into a collection of collections.

The resulting collection’s type will be guided by the static type of collection. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

• B
  • the type of the elements of each traversable collection.
• asTraversable
  • an implicit conversion which asserts that the element type of this collection is a Traversable .
• returns
  • a two-dimensional collection of collections which has as n th row the n th column of this collection.
• Definition Classes
  • GenericTraversableTemplate
• Annotations
  • @migration
• Migration
  • (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.
• Exceptions thrown
  • IllegalArgumentException if all collections in this collection are not of the same size.

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip3[A1, A2, A3](implicit asTriple: (Int) ⇒ (A1, A2, A3)): (IndexedSeq[A1], IndexedSeq[A2], IndexedSeq[A3])

Converts this collection of triples into three collections of the first, second, and third element of each triple.

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))

• A1
  • the type of the first member of the element triples
• A2
  • the type of the second member of the element triples
• A3
  • the type of the third member of the element triples
• asTriple
  • an implicit conversion which asserts that the element type of this collection is a triple.
• returns
  • a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip[A1, A2](implicit asPair: (Int) ⇒ (A1, A2)): (IndexedSeq[A1], IndexedSeq[A2])

Converts this collection of pairs into two collections of the first and second half of each pair.

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))

• A1
  • the type of the first half of the element pairs
• A2
  • the type of the second half of the element pairs
• asPair
  • an implicit conversion which asserts that the element type of this collection is a pair.
• returns
  • a pair of collections, containing the first, respectively second half of each element pair of this collection.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

Value Members From scala.collection.immutable.IndexedSeq

def companion: GenericCompanion[IndexedSeq]

The factory companion object that builds instances of class IndexedSeq. (or its Iterable superclass where class IndexedSeq is not a Seq .)

• Definition Classes
  • IndexedSeq → IndexedSeq → Seq → Seq → GenSeq → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate

(defined at scala.collection.immutable.IndexedSeq)

def seq: IndexedSeq[Int]

A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).

This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

• returns
  • a sequential view of the collection.
• Definition Classes
  • IndexedSeq → IndexedSeq → IndexedSeqLike → Seq → Seq → GenSeq → GenSeqLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.IndexedSeq)

def toIndexedSeq: IndexedSeq[Int]

Returns this immutable sequence as an indexed sequence.

A new indexed sequence will not be built; lazy collections will stay lazy.

• returns
  • an indexed sequence containing all elements of this immutable sequence.
• Definition Classes
  • IndexedSeq → TraversableOnce → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.immutable.IndexedSeq)

Instance Constructors From scala.collection.immutable.Range

new Range(start: Int, end: Int, step: Int)

• start
  • the start of this range.
• end
  • the end of the range. For exclusive ranges, e.g. Range(0,3) or (0 until 3) , this is one step past the last one in the range. For inclusive ranges, e.g. Range.inclusive(0,3) or (0 to 3) , it may be in the range if it is not skipped by the step size. To find the last element inside a non-empty range, use last instead.
• step
  • the step for the range.

(defined at scala.collection.immutable.Range)

Value Members From scala.collection.immutable.Range

final def apply(idx: Int): Int

Selects an element by its index in the range.

Example:

scala> val x = List(1, 2, 3, 4, 5)
x: List[Int] = List(1, 2, 3, 4, 5)

scala> x(3)
res1: Int = 4

• idx
  • The index to select.
• returns
  • the element of this range at index idx , where 0 indicates the first element.
• Definition Classes
  • Range → SeqLike → GenSeqLike → Function1
• Exceptions thrown
  • IndexOutOfBoundsException if idx does not satisfy 0 <= idx < length .

(defined at scala.collection.immutable.Range)

def by(step: Int): Range

Create a new range with the start and end values of this range and a new step .

• returns
  • a new range with a different step

(defined at scala.collection.immutable.Range)

final def contains(x: Int): Boolean

(defined at scala.collection.immutable.Range)

def copy(start: Int, end: Int, step: Int): Range

• Attributes
  • protected

(defined at scala.collection.immutable.Range)

final def drop(n: Int): Range

Creates a new range containing all the elements of this range except the first n elements.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• n
  • the number of elements to drop.
• returns
  • a new range consisting of all the elements of this range except n first elements.
• Definition Classes
  • Range → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def dropRight(n: Int): Range

Creates a new range consisting of the initial length - n elements of the range.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• n
  • The number of elements to take
• returns
  • a range consisting of all elements of this range except the last n ones, or else the empty range, if this range has less than n elements.
• Definition Classes
  • Range → IterableLike

(defined at scala.collection.immutable.Range)

final def dropWhile(p: (Int) ⇒ Boolean): Range

Drops longest prefix of elements that satisfy a predicate.

• returns
  • the longest suffix of this range whose first element does not satisfy the predicate p .
• Definition Classes
  • Range → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

def equals(other: Any): Boolean

The equals method for arbitrary sequences. Compares this sequence to some other object.

• returns
  • true if that is a sequence that has the same elements as this sequence in the same order, false otherwise
• Definition Classes
  • Range → GenSeqLike → Equals → AnyRef → Any

(defined at scala.collection.immutable.Range)

final def foreach[U](f: (Int) ⇒ U): Unit

[use case]

Applies a function f to all elements of this range.

Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

• f
  • the function that is applied for its side-effect to every element. The result of function f is discarded.
• Definition Classes
  • Range → IterableLike → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic

(defined at scala.collection.immutable.Range)

def inclusive: Range

Make range inclusive.

(defined at scala.collection.immutable.Range)

final def init: Range

Creates a new range containing all the elements of this range except the last one.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• returns
  • a new range consisting of all the elements of this range except the last one.
• Definition Classes
  • Range → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

def par: ParRange

Returns a parallel implementation of this collection.

For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

Specific collections (e.g. ParArray or mutable.ParHashMap ) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

All parallel collections return a reference to themselves.

• returns
  • a parallel implementation of this collection
• Definition Classes
  • Range → CustomParallelizable → Parallelizable

(defined at scala.collection.immutable.Range)

final def reverse: Range

Returns the reverse of this range.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• returns
  • A new range with all elements of this range in reversed order.
• Definition Classes
  • Range → SeqLike → GenSeqLike

(defined at scala.collection.immutable.Range)

def slice(from: Int, until: Int): Range

Creates a new range containing the elements starting at from up to but not including until .

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• from
  • the element at which to start
• until
  • the element at which to end (not included in the range)
• returns
  • a new range consisting of a contiguous interval of values in the old range
• Definition Classes
  • Range → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def span(p: (Int) ⇒ Boolean): (Range, Range)

Splits this range into a prefix/suffix pair according to a predicate.

Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p) , provided the evaluation of the predicate p does not cause any side-effects.

• returns
  • a pair consisting of the longest prefix of this range whose elements all satisfy p , and the rest of this range.
• Definition Classes
  • Range → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def splitAt(n: Int): (Range, Range)

Creates a pair of new ranges, first consisting of elements before n , and the second of elements after n .

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• n
  • the position at which to split.
• returns
  • a pair of ranges consisting of the first n elements of this range, and the other elements.
• Definition Classes
  • Range → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def tail: Range

Creates a new range containing all the elements of this range except the first one.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• returns
  • a new range consisting of all the elements of this range except the first one.
• Definition Classes
  • Range → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def take(n: Int): Range

Creates a new range containing the first n elements of this range.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• n
  • the number of elements to take.
• returns
  • a new range consisting of n first elements.
• Definition Classes
  • Range → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

final def takeRight(n: Int): Range

Creates a new range consisting of the last n elements of the range.

Note: this method does not use builders to construct a new range, and its complexity is O(1).

• n
  • the number of elements to take
• returns
  • a range consisting only of the last n elements of this range, or else the whole range, if it has less than n elements.
• Definition Classes
  • Range → IterableLike

(defined at scala.collection.immutable.Range)

final def takeWhile(p: (Int) ⇒ Boolean): Range

Takes longest prefix of elements that satisfy a predicate.

• returns
  • the longest prefix of this range whose elements all satisfy the predicate p .
• Definition Classes
  • Range → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.Range)

def toIterable: Range

Returns this range as an iterable collection.

A new collection will not be built; lazy collections will stay lazy.

• returns
  • an Iterable containing all elements of this range.
• Definition Classes
  • Range → IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.Range)

def toSeq: Range

Converts this range to a sequence.

A new collection will not be built; in particular, lazy sequences will stay lazy.

• returns
  • a sequence containing all elements of this range.
• Definition Classes
  • Range → Seq → SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.Range)

Value Members From Implicit scala.collection.parallel.CollectionsHaveToParArray ——————————————————————————–

def toParArray: ParArray[T]

• Implicit information
  • This member is added by an implicit conversion from Range to CollectionsHaveToParArray [Range, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Range) ⇒ GenTraversableOnce [T] is in scope.
• Definition Classes
  • CollectionsHaveToParArray (added by implicit convertion: scala.collection.parallel.CollectionsHaveToParArray)

Full Source:

/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2006-2013, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */


package scala
package collection.immutable

import scala.collection.parallel.immutable.ParRange

/** The `Range` class represents integer values in range
 *  ''[start;end)'' with non-zero step value `step`.
 *  It's a special case of an indexed sequence.
 *  For example:
 *
 *  {{{
 *     val r1 = 0 until 10
 *     val r2 = r1.start until r1.end by r1.step + 1
 *     println(r2.length) // = 5
 *  }}}
 *
 *  Ranges that contain more than `Int.MaxValue` elements can be created, but
 *  these overfull ranges have only limited capabilities.  Any method that
 *  could require a collection of over `Int.MaxValue` length to be created, or
 *  could be asked to index beyond `Int.MaxValue` elements will throw an
 *  exception.  Overfull ranges can safely be reduced in size by changing
 *  the step size (e.g. `by 3`) or taking/dropping elements.  `contains`,
 *  `equals`, and access to the ends of the range (`head`, `last`, `tail`,
 *  `init`) are also permitted on overfull ranges.
 *
 *  @param start      the start of this range.
 *  @param end        the end of the range.  For exclusive ranges, e.g. 
 *                    `Range(0,3)` or `(0 until 3)`, this is one
 *                    step past the last one in the range.  For inclusive
 *                    ranges, e.g. `Range.inclusive(0,3)` or `(0 to 3)`,
 *                    it may be in the range if it is not skipped by the step size.
 *                    To find the last element inside a non-empty range,
                      use `last` instead.
 *  @param step       the step for the range.
 *
 *  @author Martin Odersky
 *  @author Paul Phillips
 *  @version 2.8
 *  @since   2.5
 *  @see [[http://docs.scala-lang.org/overviews/collections/concrete-immutable-collection-classes.html#ranges "Scala's Collection Library overview"]]
 *  section on `Ranges` for more information.
 *
 *  @define coll range
 *  @define mayNotTerminateInf
 *  @define willNotTerminateInf
 *  @define doesNotUseBuilders
 *    '''Note:''' this method does not use builders to construct a new range,
 *         and its complexity is O(1).
 */
@SerialVersionUID(7618862778670199309L)
@deprecatedInheritance("The implementation details of Range makes inheriting from it unwise.", "2.11.0")
class Range(val start: Int, val end: Int, val step: Int)
extends scala.collection.AbstractSeq[Int]
   with IndexedSeq[Int]
   with scala.collection.CustomParallelizable[Int, ParRange]
   with Serializable
{
  override def par = new ParRange(this)

  private def gap           = end.toLong - start.toLong
  private def isExact       = gap % step == 0
  private def hasStub       = isInclusive || !isExact
  private def longLength    = gap / step + ( if (hasStub) 1 else 0 )

  // Check cannot be evaluated eagerly because we have a pattern where
  // ranges are constructed like: "x to y by z" The "x to y" piece
  // should not trigger an exception. So the calculation is delayed,
  // which means it will not fail fast for those cases where failing was
  // correct.
  override final val isEmpty = (
       (start > end && step > 0)
    || (start < end && step < 0)
    || (start == end && !isInclusive)
  )
  @deprecated("This method will be made private, use `length` instead.", "2.11")
  final val numRangeElements: Int = {
    if (step == 0) throw new IllegalArgumentException("step cannot be 0.")
    else if (isEmpty) 0
    else {
      val len = longLength
      if (len > scala.Int.MaxValue) -1
      else len.toInt
    }
  }
  @deprecated("This method will be made private, use `last` instead.", "2.11")
  final val lastElement = 
    if (isEmpty) start - step
    else step match {
      case 1  => if (isInclusive) end else end-1
      case -1 => if (isInclusive) end else end+1
      case _  =>
        val remainder = (gap % step).toInt
        if (remainder != 0) end - remainder
        else if (isInclusive) end
        else end - step
    }
    
  @deprecated("This method will be made private.", "2.11")
  final val terminalElement = lastElement + step

  /** The last element of this range.  This method will return the correct value
   *  even if there are too many elements to iterate over.
   */
  override def last = if (isEmpty) Nil.last else lastElement
  override def head = if (isEmpty) Nil.head else start

  override def min[A1 >: Int](implicit ord: Ordering[A1]): Int =
    if (ord eq Ordering.Int) {
      if (step > 0) head
      else last
    } else super.min(ord)

  override def max[A1 >: Int](implicit ord: Ordering[A1]): Int =
    if (ord eq Ordering.Int) {
      if (step > 0) last
      else head
    } else super.max(ord)

  protected def copy(start: Int, end: Int, step: Int): Range = new Range(start, end, step)

  /** Create a new range with the `start` and `end` values of this range and
   *  a new `step`.
   *
   *  @return a new range with a different step
   */
  def by(step: Int): Range = copy(start, end, step)

  def isInclusive = false

  override def size = length
  override def length = if (numRangeElements < 0) fail() else numRangeElements

  private def description = "%d %s %d by %s".format(start, if (isInclusive) "to" else "until", end, step)
  private def fail() = throw new IllegalArgumentException(description + ": seqs cannot contain more than Int.MaxValue elements.")
  private def validateMaxLength() {
    if (numRangeElements < 0)
      fail()
  }

  final def apply(idx: Int): Int = {
    validateMaxLength()
    if (idx < 0 || idx >= numRangeElements) throw new IndexOutOfBoundsException(idx.toString)
    else start + (step * idx)
  }

  @inline final override def foreach[@specialized(Unit) U](f: Int => U) {
    // Implementation chosen on the basis of favorable microbenchmarks
    // Note--initialization catches step == 0 so we don't need to here
    if (!isEmpty) {
      var i = start
      while (true) {
        f(i)
        if (i == lastElement) return
        i += step
      }
    }
  }

  /** Creates a new range containing the first `n` elements of this range.
   *
   *  $doesNotUseBuilders
   *
   *  @param n  the number of elements to take.
   *  @return   a new range consisting of `n` first elements.
   */
  final override def take(n: Int): Range = (
    if (n <= 0 || isEmpty) newEmptyRange(start)
    else if (n >= numRangeElements && numRangeElements >= 0) this
    else {
      // May have more than Int.MaxValue elements in range (numRangeElements < 0)
      // but the logic is the same either way: take the first n
      new Range.Inclusive(start, locationAfterN(n - 1), step)
    }
  )

  /** Creates a new range containing all the elements of this range except the first `n` elements.
   *
   *  $doesNotUseBuilders
   *
   *  @param n  the number of elements to drop.
   *  @return   a new range consisting of all the elements of this range except `n` first elements.
   */
  final override def drop(n: Int): Range = (
    if (n <= 0 || isEmpty) this
    else if (n >= numRangeElements && numRangeElements >= 0) newEmptyRange(end)
    else {
      // May have more than Int.MaxValue elements (numRangeElements < 0)
      // but the logic is the same either way: go forwards n steps, keep the rest
      copy(locationAfterN(n), end, step)
    }
  )
  
  /** Creates a new range containing the elements starting at `from` up to but not including `until`.
   *
   *  $doesNotUseBuilders
   *
   *  @param from  the element at which to start
   *  @param until  the element at which to end (not included in the range)
   *  @return   a new range consisting of a contiguous interval of values in the old range
   */
  override def slice(from: Int, until: Int): Range =
    if (from <= 0) take(until)
    else if (until >= numRangeElements && numRangeElements >= 0) drop(from)
    else {
      val fromValue = locationAfterN(from)
      if (from >= until) newEmptyRange(fromValue)
      else new Range.Inclusive(fromValue, locationAfterN(until-1), step)
    }
    
  /** Creates a new range containing all the elements of this range except the last one.
   *
   *  $doesNotUseBuilders
   *
   *  @return  a new range consisting of all the elements of this range except the last one.
   */
  final override def init: Range = {
    if (isEmpty)
      Nil.init

    dropRight(1)
  }

  /** Creates a new range containing all the elements of this range except the first one.
   *
   *  $doesNotUseBuilders
   *
   *  @return  a new range consisting of all the elements of this range except the first one.
   */
  final override def tail: Range = {
    if (isEmpty)
      Nil.tail

    drop(1)
  }

  // Advance from the start while we meet the given test
  private def argTakeWhile(p: Int => Boolean): Long = {
    if (isEmpty) start
    else {
      var current = start
      val stop = last
      while (current != stop && p(current)) current += step
      if (current != stop || !p(current)) current
      else current.toLong + step
    }
  }
  // Methods like apply throw exceptions on invalid n, but methods like take/drop
  // are forgiving: therefore the checks are with the methods.
  private def locationAfterN(n: Int) = start + (step * n)

  // When one drops everything.  Can't ever have unchecked operations
  // like "end + 1" or "end - 1" because ranges involving Int.{ MinValue, MaxValue }
  // will overflow.  This creates an exclusive range where start == end
  // based on the given value.
  private def newEmptyRange(value: Int) = new Range(value, value, step)

  final override def takeWhile(p: Int => Boolean): Range = {
    val stop = argTakeWhile(p)
    if (stop==start) newEmptyRange(start)
    else {
      val x = (stop - step).toInt
      if (x == last) this
      else new Range.Inclusive(start, x, step)
    }
  }
  final override def dropWhile(p: Int => Boolean): Range = {
    val stop = argTakeWhile(p)
    if (stop == start) this
    else {
      val x = (stop - step).toInt
      if (x == last) newEmptyRange(last)
      else new Range.Inclusive(x + step, last, step)
    }
  }
  final override def span(p: Int => Boolean): (Range, Range) = {
    val border = argTakeWhile(p)
    if (border == start) (newEmptyRange(start), this)
    else {
      val x = (border - step).toInt
      if (x == last) (this, newEmptyRange(last))
      else (new Range.Inclusive(start, x, step), new Range.Inclusive(x+step, last, step))
    }
  }

  /** Creates a pair of new ranges, first consisting of elements before `n`, and the second
   *  of elements after `n`.
   *
   *  $doesNotUseBuilders
   */
  final override def splitAt(n: Int) = (take(n), drop(n))

  /** Creates a new range consisting of the last `n` elements of the range.
   *
   *  $doesNotUseBuilders
   */
  final override def takeRight(n: Int): Range = {
    if (n <= 0) newEmptyRange(start)
    else if (numRangeElements >= 0) drop(numRangeElements - n)
    else {
    // Need to handle over-full range separately
      val y = last
      val x = y - step.toLong*(n-1)
      if ((step > 0 && x < start) || (step < 0 && x > start)) this
      else new Range.Inclusive(x.toInt, y, step)
    }
  }

  /** Creates a new range consisting of the initial `length - n` elements of the range.
   *
   *  $doesNotUseBuilders
   */
  final override def dropRight(n: Int): Range = {
    if (n <= 0) this
    else if (numRangeElements >= 0) take(numRangeElements - n)
    else {
    // Need to handle over-full range separately
      val y = last - step.toInt*n
      if ((step > 0 && y < start) || (step < 0 && y > start)) newEmptyRange(start)
      else new Range.Inclusive(start, y.toInt, step)
    }
  }

  /** Returns the reverse of this range.
   *
   *  $doesNotUseBuilders
   */
  final override def reverse: Range =
    if (isEmpty) this
    else new Range.Inclusive(last, start, -step)

  /** Make range inclusive.
   */
  def inclusive =
    if (isInclusive) this
    else new Range.Inclusive(start, end, step)

  final def contains(x: Int) = {
    if (x==end && !isInclusive) false
    else if (step > 0) {
      if (x < start || x > end) false
      else (step == 1) || (((x - start) % step) == 0)
    }
    else {
      if (x < end || x > start) false
      else (step == -1) || (((x - start) % step) == 0)
    }
  }

  final override def sum[B >: Int](implicit num: Numeric[B]): Int = {
    if (num eq scala.math.Numeric.IntIsIntegral) {
      // this is normal integer range with usual addition. arithmetic series formula can be used
      if (isEmpty) 0
      else if (numRangeElements == 1) head
      else ((numRangeElements * (head.toLong + last)) / 2).toInt
    } else {
      // user provided custom Numeric, we cannot rely on arithmetic series formula
      if (isEmpty) num.toInt(num.zero)
      else {
        var acc = num.zero
        var i = head
        while (true) {
          acc = num.plus(acc, i)
          if (i == lastElement) return num.toInt(acc)
          i = i + step
        }
        0 // Never hit this--just to satisfy compiler since it doesn't know while(true) has type Nothing
      }
    }
  }

  override def toIterable = this

  override def toSeq = this

  override def equals(other: Any) = other match {
    case x: Range =>
      // Note: this must succeed for overfull ranges (length > Int.MaxValue)
      (x canEqual this) && {
        if (isEmpty) x.isEmpty                  // empty sequences are equal
        else                                    // this is non-empty...
          x.nonEmpty && start == x.start && {   // ...so other must contain something and have same start
            val l0 = last
            (l0 == x.last && (                    // And same end
              start == l0 || step == x.step       // And either the same step, or not take any steps
            ))
          }
      }
    case _ =>
      super.equals(other)
  }
  /** Note: hashCode can't be overridden without breaking Seq's
   *  equals contract.
   */

  override def toString() = {
    val endStr =
      if (numRangeElements > Range.MAX_PRINT || (!isEmpty && numRangeElements < 0)) ", ... )" else ")"
    take(Range.MAX_PRINT).mkString("Range(", ", ", endStr)
  }
}

/** A companion object for the `Range` class.
 */
object Range {
  private[immutable] val MAX_PRINT = 512  // some arbitrary value

  /** Counts the number of range elements.
   *  @pre  step != 0
   *  If the size of the range exceeds Int.MaxValue, the
   *  result will be negative.
   */
  def count(start: Int, end: Int, step: Int, isInclusive: Boolean): Int = {
    if (step == 0)
      throw new IllegalArgumentException("step cannot be 0.")

    val isEmpty = (
      if (start == end) !isInclusive
      else if (start < end) step < 0
      else step > 0
    )
    if (isEmpty) 0
    else {
      // Counts with Longs so we can recognize too-large ranges.
      val gap: Long    = end.toLong - start.toLong
      val jumps: Long  = gap / step
      // Whether the size of this range is one larger than the
      // number of full-sized jumps.
      val hasStub      = isInclusive || (gap % step != 0)
      val result: Long = jumps + ( if (hasStub) 1 else 0 )

      if (result > scala.Int.MaxValue) -1
      else result.toInt
    }
  }
  def count(start: Int, end: Int, step: Int): Int =
    count(start, end, step, isInclusive = false)

  class Inclusive(start: Int, end: Int, step: Int) extends Range(start, end, step) {
//    override def par = new ParRange(this)
    override def isInclusive = true
    override protected def copy(start: Int, end: Int, step: Int): Range = new Inclusive(start, end, step)
  }

  /** Make a range from `start` until `end` (exclusive) with given step value.
   * @note step != 0
   */
  def apply(start: Int, end: Int, step: Int): Range = new Range(start, end, step)

  /** Make a range from `start` until `end` (exclusive) with step value 1.
   */
  def apply(start: Int, end: Int): Range = new Range(start, end, 1)

  /** Make an inclusive range from `start` to `end` with given step value.
   * @note step != 0
   */
  def inclusive(start: Int, end: Int, step: Int): Range.Inclusive = new Inclusive(start, end, step)

  /** Make an inclusive range from `start` to `end` with step value 1.
   */
  def inclusive(start: Int, end: Int): Range.Inclusive = new Inclusive(start, end, 1)

  // BigInt and Long are straightforward generic ranges.
  object BigInt {
    def apply(start: BigInt, end: BigInt, step: BigInt) = NumericRange(start, end, step)
    def inclusive(start: BigInt, end: BigInt, step: BigInt) = NumericRange.inclusive(start, end, step)
  }

  object Long {
    def apply(start: Long, end: Long, step: Long) = NumericRange(start, end, step)
    def inclusive(start: Long, end: Long, step: Long) = NumericRange.inclusive(start, end, step)
  }

  // BigDecimal uses an alternative implementation of Numeric in which
  // it pretends to be Integral[T] instead of Fractional[T].  See Numeric for
  // details.  The intention is for it to throw an exception anytime
  // imprecision or surprises might result from anything, although this may
  // not yet be fully implemented.
  object BigDecimal {
    implicit val bigDecAsIntegral = scala.math.Numeric.BigDecimalAsIfIntegral

    def apply(start: BigDecimal, end: BigDecimal, step: BigDecimal) =
      NumericRange(start, end, step)
    def inclusive(start: BigDecimal, end: BigDecimal, step: BigDecimal) =
      NumericRange.inclusive(start, end, step)
  }

  // Double works by using a BigDecimal under the hood for precise
  // stepping, but mapping the sequence values back to doubles with
  // .doubleValue.  This constructs the BigDecimals by way of the
  // String constructor (valueOf) instead of the Double one, which
  // is necessary to keep 0.3d at 0.3 as opposed to
  // 0.299999999999999988897769753748434595763683319091796875 or so.
  object Double {
    implicit val bigDecAsIntegral = scala.math.Numeric.BigDecimalAsIfIntegral
    implicit val doubleAsIntegral = scala.math.Numeric.DoubleAsIfIntegral
    def toBD(x: Double): BigDecimal = scala.math.BigDecimal valueOf x

    def apply(start: Double, end: Double, step: Double) =
      BigDecimal(toBD(start), toBD(end), toBD(step)) mapRange (_.doubleValue)

    def inclusive(start: Double, end: Double, step: Double) =
      BigDecimal.inclusive(toBD(start), toBD(end), toBD(step)) mapRange (_.doubleValue)
  }

  // As there is no appealing default step size for not-really-integral ranges,
  // we offer a partially constructed object.
  class Partial[T, U](f: T => U) {
    def by(x: T): U = f(x)
  }

  // Illustrating genericity with Int Range, which should have the same behavior
  // as the original Range class.  However we leave the original Range
  // indefinitely, for performance and because the compiler seems to bootstrap
  // off it and won't do so with our parameterized version without modifications.
  object Int {
    def apply(start: Int, end: Int, step: Int) = NumericRange(start, end, step)
    def inclusive(start: Int, end: Int, step: Int) = NumericRange.inclusive(start, end, step)
  }
}