final class Chain[+T] extends AnyVal

A non-empty list: an ordered, immutable, non-empty collection of elements with LinearSeq performance characteristics.

The purpose of Chain is to allow you to express in a type that a List is non-empty, thereby eliminating the need for (and potential exception from) a run-time check for non-emptiness. For a non-empty sequence with IndexedSeq performance, see Every.

Constructing Chains

You can construct a Chain by passing one or more elements to the Chain.apply factory method:

scala> Chain(1, 2, 3)
res0: org.scalactic.Chain[Int] = Chain(1, 2, 3)

Alternatively you can cons elements onto the End singleton object, similar to making a List starting with Nil:

scala> 1 :: 2 :: 3 :: Nil
res0: List[Int] = List(1, 2, 3)

scala> 1 :: 2 :: 3 :: End
res1: org.scalactic.Chain[Int] = Chain(1, 2, 3)

Note that although Nil is a List[Nothing], End is not a Chain[Nothing], because no empty Chain exists. (A chain is a series of connected links; if you have no links, you have no chain.)

scala> val nil: List[Nothing] = Nil
nil: List[Nothing] = List()

scala> val nada: Chain[Nothing] = End
<console>:16: error: type mismatch;
found   : org.scalactic.End.type
required: org.scalactic.Chain[Nothing]
       val nada: Chain[Nothing] = End
                                  ^

Working with Chains

Chain does not extend Scala's Seq or Traversable traits because these require that implementations may be empty. For example, if you invoke tail on a Seq that contains just one element, you'll get an empty Seq:

scala> List(1).tail
res6: List[Int] = List()

On the other hand, many useful methods exist on Seq that when invoked on a non-empty Seq are guaranteed to not result in an empty Seq. For convenience, Chain defines a method corresponding to every such Seq method. Here are some examples:

Chain(1, 2, 3).map(_ + 1)                 // Result: Chain(2, 3, 4)
Chain(1).map(_ + 1)                       // Result: Chain(2)
Chain(1, 2, 3).containsSlice(Chain(2, 3)) // Result: true
Chain(1, 2, 3).containsSlice(Chain(3, 4)) // Result: false
Chain(-1, -2, 3, 4, 5).minBy(_.abs)       // Result: -1

Chain does not currently define any methods corresponding to Seq methods that could result in an empty Seq. However, an implicit converison from Chain to List is defined in the Chain companion object that will be applied if you attempt to call one of the missing methods. As a result, you can invoke filter on an Chain, even though filter could result in an empty sequence—but the result type will be List instead of Chain:

Chain(1, 2, 3).filter(_ < 10) // Result: List(1, 2, 3)
Chain(1, 2, 3).filter(_ > 10) // Result: List()

You can use Chains in for expressions. The result will be an Chain unless you use a filter (an if clause). Because filters are desugared to invocations of filter, the result type will switch to a List at that point. Here are some examples:

scala> import org.scalactic._
import org.scalactic._

scala> for (i <- Chain(1, 2, 3)) yield i + 1
res0: org.scalactic.Chain[Int] = Chain(2, 3, 4)

scala> for (i <- Chain(1, 2, 3) if i < 10) yield i + 1
res1: List[Int] = List(2, 3, 4)

scala> for {
     |   i <- Chain(1, 2, 3)
     |   j <- Chain('a', 'b', 'c')
     | } yield (i, j)
res3: org.scalactic.Chain[(Int, Char)] =
        Chain((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

scala> for {
     |   i <- Chain(1, 2, 3) if i < 10
     |   j <- Chain('a', 'b', 'c')
     | } yield (i, j)
res6: List[(Int, Char)] =
        List((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

T

the type of elements contained in this Chain

Source
Chain.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Chain
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def ++[U >: T](other: GenTraversableOnce[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed GenTraversableOnce.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed GenTraversableOnce. The element type of the resulting Chain is the most specific superclass encompassing the element types of this Chain and the passed GenTraversableOnce.

    U

    the element type of the returned Chain

    other

    the GenTraversableOnce to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  4. def ++[U >: T](other: Every[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Every.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Every. The element type of the resulting Chain is the most specific superclass encompassing the element types of this Chain and the passed Every.

    U

    the element type of the returned Chain

    other

    the Every to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  5. def ++[U >: T](other: Chain[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Chain.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Chain. The element type of the resulting Chain is the most specific superclass encompassing the element types of this and the passed Chain.

    U

    the element type of the returned Chain

    other

    the Chain to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  6. final def +:[U >: T](element: U): Chain[U]

    Returns a new Chain with the given element prepended.

    Returns a new Chain with the given element prepended.

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

    element

    the element to prepend to this Chain

    returns

    a new Chain consisting of element followed by all elements of this Chain.

  7. final def /:[B](z: B)(op: (B, T) ⇒ B): B

    Fold left: applies a binary operator to a start value, z, and all elements of this Chain, going left to right.

    Fold left: applies a binary operator to a start value, z, and all elements of this Chain, going left to right.

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

    B

    the result of the binary operator

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this Chain, 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 Chain.

  8. def :+[U >: T](element: U): Chain[U]

    Returns a new Chain with the given element appended.

    Returns a new Chain with the given element appended.

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

    element

    the element to append to this Chain

    returns

    a new Chain consisting of all elements of this Chain followed by element.

  9. final def ::[U >: T](element: U): Chain[U]

    Adds an element to the beginning of this Chain.

    Adds an element to the beginning of this Chain.

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

    element

    the element to prepend to this Chain

    returns

    a Chain that contains element as first element and that continues with this Chain.

  10. def :::[U >: T](other: GenTraversableOnce[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed GenTraversableOnce.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed GenTraversableOnce. The element type of the resulting Chain is the most specific superclass encompassing the element types of this Chain and the passed GenTraversableOnce.

    U

    the element type of the returned Chain

    other

    the GenTraversableOnce to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  11. def :::[U >: T](other: Every[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Every.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Every. The element type of the resulting Chain is the most specific superclass encompassing the element types of this and the passed Every.

    U

    the element type of the returned Chain

    other

    the Every to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  12. def :::[U >: T](other: Chain[U]): Chain[U]

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Chain.

    Returns a new Chain containing the elements of this Chain followed by the elements of the passed Chain. The element type of the resulting Chain is the most specific superclass encompassing the element types of this and the passed Chain.

    U

    the element type of the returned Chain

    other

    the Chain to append

    returns

    a new Chain that contains all the elements of this Chain followed by all elements of other.

  13. final def :\[B](z: B)(op: (T, B) ⇒ B): B

    Fold right: applies a binary operator to all elements of this Chain and a start value, going right to left.

    Fold right: applies a binary operator to all elements of this Chain and a start value, going right to left.

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

    B

    the result of the binary operator

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this Chain, 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 Chain.

  14. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  15. final def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Appends all elements of this Chain to a string builder using start, end, and separator strings.

    Appends all elements of this Chain to a string builder using start, end, and separator strings. The written text will consist of a concatenation of the string start; the result of invoking toString on all elements of this Chain, separated by the string sep; and the string end

    sb

    the string builder to which elements will be appended

    start

    the ending string

    sep

    the separator string

    returns

    the string builder, sb, to which elements were appended.

  16. final def addString(sb: StringBuilder, sep: String): StringBuilder

    Appends all elements of this Chain to a string builder using a separator string.

    Appends all elements of this Chain to a string builder using a separator string. The written text will consist of a concatenation of the result of invoking toString on of every element of this Chain, separated by the string sep.

    sb

    the string builder to which elements will be appended

    sep

    the separator string

    returns

    the string builder, sb, to which elements were appended.

  17. final def addString(sb: StringBuilder): StringBuilder

    Appends all elements of this Chain to a string builder.

    Appends all elements of this Chain to a string builder. The written text will consist of a concatenation of the result of invoking toString on of every element of this Chain, without any separator string.

    sb

    the string builder to which elements will be appended

    returns

    the string builder, sb, to which elements were appended.

  18. final def apply(idx: Int): T

    Selects an element by its index in the Chain.

    Selects an element by its index in the Chain.

    returns

    the element of this Chain at index idx, where 0 indicates the first element.

  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. final def collectFirst[U](pf: PartialFunction[T, U]): Option[U]

    Finds the first element of this Chain for which the given partial function is defined, if any, and applies the partial function to it.

    Finds the first element of this Chain for which the given partial function is defined, if any, and applies the partial function to it.

    pf

    the partial function

    returns

    an Option containing pf applied to the first element for which it is defined, or None if the partial function was not defined for any element.

  21. final def contains(elem: Any): Boolean

    Indicates whether this Chain contains a given value as an element.

    Indicates whether this Chain contains a given value as an element.

    elem

    the element to look for

    returns

    true if this Chain has an element that is equal (as determined by ==) to elem, false otherwise.

  22. final def containsSlice[B](that: Chain[B]): Boolean

    Indicates whether this Chain contains a given Chain as a slice.

    Indicates whether this Chain contains a given Chain as a slice.

    that

    the Chain slice to look for

    returns

    true if this Chain contains a slice with the same elements as that, otherwise false.

  23. final def containsSlice[B](that: Every[B]): Boolean

    Indicates whether this Chain contains a given Every as a slice.

    Indicates whether this Chain contains a given Every as a slice.

    that

    the Every slice to look for

    returns

    true if this Chain contains a slice with the same elements as that, otherwise false.

  24. final def containsSlice[B](that: GenSeq[B]): Boolean

    Indicates whether this Chain contains a given GenSeq as a slice.

    Indicates whether this Chain contains a given GenSeq as a slice.

    that

    the GenSeq slice to look for

    returns

    true if this Chain contains a slice with the same elements as that, otherwise false.

  25. final def copyToArray[U >: T](arr: Array[U], start: Int, len: Int): Unit

    Copies values of this Chain to an array.

    Copies values of this Chain to an array. Fills the given array arr with at most len elements of this Chain, beginning at index start. Copying will stop once either the end of the current Chain is reached, the end of the array is reached, or len elements have been copied.

    arr

    the array to fill

    start

    the starting index

    len

    the maximum number of elements to copy

  26. final def copyToArray[U >: T](arr: Array[U], start: Int): Unit

    Copies values of this Chain to an array.

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

    arr

    the array to fill

    start

    the starting index

  27. final def copyToArray[U >: T](arr: Array[U]): Unit

    Copies values of this Chain to an array.

    Copies values of this Chain to an array. Fills the given array arr with values of this Chain. Copying will stop once either the end of the current Chain is reached, or the end of the array is reached.

    arr

    the array to fill

  28. final def copyToBuffer[U >: T](buf: Buffer[U]): Unit

    Copies all elements of this Chain to a buffer.

    Copies all elements of this Chain to a buffer.

    buf

    the buffer to which elements are copied

  29. final def corresponds[B](that: Chain[B])(p: (T, B) ⇒ Boolean): Boolean

    Indicates whether every element of this Chain relates to the corresponding element of a given Chain by satisfying a given predicate.

    Indicates whether every element of this Chain relates to the corresponding element of a given Chain by satisfying a given predicate.

    B

    the type of the elements of that

    that

    the Chain to compare for correspondence

    p

    the predicate, which relates elements from this and the passed Chain

    returns

    true if this and the passed Chain have the same length and p(x, y) is true for all corresponding elements x of this Chain and y of that, otherwise false.

  30. final def corresponds[B](that: Every[B])(p: (T, B) ⇒ Boolean): Boolean

    Indicates whether every element of this Chain relates to the corresponding element of a given Every by satisfying a given predicate.

    Indicates whether every element of this Chain relates to the corresponding element of a given Every by satisfying a given predicate.

    B

    the type of the elements of that

    that

    the Every to compare for correspondence

    p

    the predicate, which relates elements from this Chain and the passed Every

    returns

    true if this Chain and the passed Every have the same length and p(x, y) is true for all corresponding elements x of this Chain and y of that, otherwise false.

  31. final def corresponds[B](that: GenSeq[B])(p: (T, B) ⇒ Boolean): Boolean

    Indicates whether every element of this Chain relates to the corresponding element of a given GenSeq by satisfying a given predicate.

    Indicates whether every element of this Chain relates to the corresponding element of a given GenSeq by satisfying a given predicate.

    B

    the type of the elements of that

    that

    the GenSeq to compare for correspondence

    p

    the predicate, which relates elements from this Chain and the passed GenSeq

    returns

    true if this Chain and the passed GenSeq have the same length and p(x, y) is true for all corresponding elements x of this Chain and y of that, otherwise false.

  32. final def count(p: (T) ⇒ Boolean): Int

    Counts the number of elements in this Chain that satisfy a predicate.

    Counts the number of elements in this Chain that satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

  33. final def distinct: Chain[T]

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

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

    returns

    A new Chain that contains the first occurrence of every element of this Chain.

  34. final def endsWith[B](that: Chain[B]): Boolean

    Indicates whether this Chain ends with the given Chain.

    Indicates whether this Chain ends with the given Chain.

    that

    the Chain to test

    returns

    true if this Chain has that as a suffix, false otherwise.

  35. final def endsWith[B](that: Every[B]): Boolean

    Indicates whether this Chain ends with the given Every.

    Indicates whether this Chain ends with the given Every.

    that

    the Every to test

    returns

    true if this Chain has that as a suffix, false otherwise.

  36. final def endsWith[B](that: GenSeq[B]): Boolean

    Indicates whether this Chain ends with the given GenSeq.

    Indicates whether this Chain ends with the given GenSeq.

    that

    the sequence to test

    returns

    true if this Chain has that as a suffix, false otherwise.

  37. final def exists(p: (T) ⇒ Boolean): Boolean

    Indicates whether a predicate holds for at least one of the elements of this Chain.

    Indicates whether a predicate holds for at least one of the elements of this Chain.

    returns

    true if the given predicate p holds for some of the elements of this Chain, otherwise false.

  38. final def find(p: (T) ⇒ Boolean): Option[T]

    Finds the first element of this Chain that satisfies the given predicate, if any.

    Finds the first element of this Chain that satisfies the given predicate, if any.

    p

    the predicate used to test elements

    returns

    an Some containing the first element in this Chain that satisfies p, or None if none exists.

  39. final def flatMap[U](f: (T) ⇒ Chain[U]): Chain[U]

    Builds a new Chain by applying a function to all elements of this Chain and using the elements of the resulting Chains.

    Builds a new Chain by applying a function to all elements of this Chain and using the elements of the resulting Chains.

    U

    the element type of the returned Chain

    f

    the function to apply to each element.

    returns

    a new Chain containing elements obtained by applying the given function f to each element of this Chain and concatenating the elements of resulting Chains.

  40. final def flatten[B](implicit ev: <:<[T, Chain[B]]): Chain[B]

    Converts this Chain of Chains into a Chain formed by the elements of the nested Chains.

    Converts this Chain of Chains into a Chain formed by the elements of the nested Chains.

    Note: You cannot use this flatten method on a Chain that contains a GenTraversableOnces, because if all the nested GenTraversableOnces were empty, you'd end up with an empty Chain.

    returns

    a new Chain resulting from concatenating all nested Chains.

  41. final def fold[U >: T](z: U)(op: (U, U) ⇒ U): U

    Folds the elements of this Chain using the specified associative binary operator.

    Folds the elements of this Chain using the specified associative binary operator.

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

    U

    a type parameter for the binary operator, a supertype of T.

    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 fold operator op between all the elements and z

  42. final def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

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

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

    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 Chain, 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 Chain.

  43. final def foldRight[B](z: B)(op: (T, B) ⇒ B): B

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

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

    B

    the result of the binary operator

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this Chain, 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 Chain.

  44. final def forall(p: (T) ⇒ Boolean): Boolean

    Indicates whether a predicate holds for all elements of this Chain.

    Indicates whether a predicate holds for all elements of this Chain.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for all elements of this Chain, otherwise false.

  45. final def foreach(f: (T) ⇒ Unit): Unit

    Applies a function f to all elements of this Chain.

    Applies a function f to all elements of this Chain.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

  46. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  47. final def groupBy[K](f: (T) ⇒ K): Map[K, Chain[T]]

    Partitions this Chain into a map of Chains according to some discriminator function.

    Partitions this Chain into a map of Chains according to some discriminator function.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to Chains such that the following invariant holds: 

    (chain.toList partition f)(k) = xs filter (x => f(x) == k)
    That is, every key k is bound to a Chain of those elements x for which f(x) equals k.

  48. final def grouped(size: Int): Iterator[Chain[T]]

    Partitions elements into fixed size Chains.

    Partitions elements into fixed size Chains.

    size

    the number of elements per group

    returns

    An iterator producing Chains of size size, except the last will be truncated if the elements don't divide evenly.

  49. final def hasDefiniteSize: Boolean

    Returns true to indicate this Chain has a definite size, since all Chains are strict collections.

  50. final def head: T

    Selects the first element of this Chain.

    Selects the first element of this Chain.

    returns

    the first element of this Chain.

  51. final def headOption: Option[T]

    Selects the first element of this Chain and returns it wrapped in a Some.

    Selects the first element of this Chain and returns it wrapped in a Some.

    returns

    the first element of this Chain, wrapped in a Some.

  52. final def indexOf[U >: T](elem: U, from: Int): Int

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

    Finds index of first occurrence of some value in this Chain 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 Chain that is equal (as determined by ==) to elem, or -1, if none exists.

  53. final def indexOf[U >: T](elem: U): Int

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

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

    elem

    the element value to search for.

    returns

    the index of the first element of this Chain that is equal (as determined by ==) to elem, or -1, if none exists.

  54. final def indexOfSlice[U >: T](that: Chain[U], from: Int): Int

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

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

    that

    the Chain defining the slice to look for

    from

    the start index

    returns

    the first index >= from such that the elements of this Chain starting at this index match the elements of Chain that, or -1 of no such subsequence exists.

  55. final def indexOfSlice[U >: T](that: Every[U], from: Int): Int

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

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

    that

    the Every defining the slice to look for

    from

    the start index

    returns

    the first index >= from such that the elements of this Chain starting at this index match the elements of Every that, or -1 of no such subsequence exists.

  56. final def indexOfSlice[U >: T](that: Chain[U]): Int

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

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

    that

    the Chain defining the slice to look for

    returns

    the first index such that the elements of this Chain starting at this index match the elements of Chain that, or -1 of no such subsequence exists.

  57. final def indexOfSlice[U >: T](that: Every[U]): Int

    Finds first index where this Chain contains a given Every as a slice.

    Finds first index where this Chain contains a given Every as a slice.

    that

    the Every defining the slice to look for

    returns

    the first index such that the elements of this Chain starting at this index match the elements of Every that, or -1 of no such subsequence exists.

  58. final def indexOfSlice[U >: T](that: GenSeq[U], from: Int): Int

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

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

    that

    the GenSeq defining the slice to look for

    from

    the start index

    returns

    the first index >= from at which the elements of this Chain starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

  59. final def indexOfSlice[U >: T](that: GenSeq[U]): Int

    Finds first index where this Chain contains a given GenSeq as a slice.

    Finds first index where this Chain contains a given GenSeq as a slice.

    that

    the GenSeq defining the slice to look for

    returns

    the first index at which the elements of this Chain starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

  60. final def indexWhere(p: (T) ⇒ Boolean, from: Int): Int

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

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

    p

    the predicate used to test elements.

    from

    the start index

    returns

    the index >= from of the first element of this Chain that satisfies the predicate p, or -1, if none exists.

  61. final def indexWhere(p: (T) ⇒ Boolean): Int

    Finds index of the first element satisfying some predicate.

    Finds index of the first element satisfying some predicate.

    p

    the predicate used to test elements.

    returns

    the index of the first element of this Chain that satisfies the predicate p, or -1, if none exists.

  62. final def indices: Range

    Produces the range of all indices of this Chain.

    Produces the range of all indices of this Chain.

    returns

    a Range value from 0 to one less than the length of this Chain.

  63. final def isDefinedAt(idx: Int): Boolean

    Tests whether this Chain contains given index.

    Tests whether this Chain contains given index.

    idx

    the index to test

    returns

    true if this Chain contains an element at position idx, false otherwise.

  64. final def isEmpty: Boolean

    Returns false to indicate this Chain, like all Chains, is non-empty.

    Returns false to indicate this Chain, like all Chains, is non-empty.

    returns

    false

  65. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  66. final def isTraversableAgain: Boolean

    Returns true to indicate this Chain, like all Chains, can be traversed repeatedly.

    Returns true to indicate this Chain, like all Chains, can be traversed repeatedly.

    returns

    true

  67. final def iterator: Iterator[T]

    Creates and returns a new iterator over all elements contained in this Chain.

    Creates and returns a new iterator over all elements contained in this Chain.

    returns

    the new iterator

  68. final def last: T

    Selects the last element of this Chain.

    Selects the last element of this Chain.

    returns

    the last element of this Chain.

  69. final def lastIndexOf[U >: T](elem: U, end: Int): Int

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

    Finds the index of the last occurrence of some value in this Chain 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 Chain that is equal (as determined by ==) to elem, or -1, if none exists.

  70. final def lastIndexOf[U >: T](elem: U): Int

    Finds the index of the last occurrence of some value in this Chain.

    Finds the index of the last occurrence of some value in this Chain.

    elem

    the element value to search for.

    returns

    the index of the last element of this Chain that is equal (as determined by ==) to elem, or -1, if none exists.

  71. final def lastIndexOfSlice[U >: T](that: Chain[U], end: Int): Int

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

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

    that

    the Chain defining the slice to look for

    end

    the end index

    returns

    the last index >= end at which the elements of this Chain starting at that index match the elements of Chain that, or -1 of no such subsequence exists.

  72. final def lastIndexOfSlice[U >: T](that: Every[U], end: Int): Int

    Finds the last index before or at a given end index where this Chain contains a given Every as a slice.

    Finds the last index before or at a given end index where this Chain contains a given Every as a slice.

    that

    the Every defining the slice to look for

    end

    the end index

    returns

    the last index >= end at which the elements of this Chain starting at that index match the elements of Every that, or -1 of no such subsequence exists.

  73. final def lastIndexOfSlice[U >: T](that: Chain[U]): Int

    Finds the last index where this Chain contains a given Chain as a slice.

    Finds the last index where this Chain contains a given Chain as a slice.

    that

    the Chain defining the slice to look for

    returns

    the last index at which the elements of this Chain starting at that index match the elements of Chain that, or -1 of no such subsequence exists.

  74. final def lastIndexOfSlice[U >: T](that: Every[U]): Int

    Finds the last index where this Chain contains a given Every as a slice.

    Finds the last index where this Chain contains a given Every as a slice.

    that

    the Every defining the slice to look for

    returns

    the last index at which the elements of this Chain starting at that index match the elements of Every that, or -1 of no such subsequence exists.

  75. final def lastIndexOfSlice[U >: T](that: GenSeq[U], end: Int): Int

    Finds the last index before or at a given end index where this Chain contains a given GenSeq as a slice.

    Finds the last index before or at a given end index where this Chain contains a given GenSeq as a slice.

    that

    the GenSeq defining the slice to look for

    end

    the end index

    returns

    the last index >= end at which the elements of this Chain starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

  76. final def lastIndexOfSlice[U >: T](that: GenSeq[U]): Int

    Finds the last index where this Chain contains a given GenSeq as a slice.

    Finds the last index where this Chain contains a given GenSeq as a slice.

    that

    the GenSeq defining the slice to look for

    returns

    the last index at which the elements of this Chain starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

  77. final def lastIndexWhere(p: (T) ⇒ Boolean, end: Int): Int

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

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

    p

    the predicate used to test elements.

    end

    the end index

    returns

    the index >= end of the last element of this Chain that satisfies the predicate p, or -1, if none exists.

  78. final def lastIndexWhere(p: (T) ⇒ Boolean): Int

    Finds index of last element satisfying some predicate.

    Finds index of last element satisfying some predicate.

    p

    the predicate used to test elements.

    returns

    the index of the last element of this Chain that satisfies the predicate p, or -1, if none exists.

  79. final def lastOption: Option[T]

    Returns the last element of this Chain, wrapped in a Some.

    Returns the last element of this Chain, wrapped in a Some.

    returns

    the last element, wrapped in a Some.

  80. final def length: Int

    The length of this Chain.

    The length of this Chain.

    Note: length and size yield the same result, which will be >= 1.

    returns

    the number of elements in this Chain.

  81. final def lengthCompare(len: Int): Int

    Compares the length of this Chain to a test value.

    Compares the length of this Chain 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

  82. final def map[U](f: (T) ⇒ U): Chain[U]

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

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

    U

    the element type of the returned Chain.

    f

    the function to apply to each element.

    returns

    a new Chain resulting from applying the given function f to each element of this Chain and collecting the results.

  83. final def max[U >: T](implicit cmp: Ordering[U]): T

    Finds the largest element.

    Finds the largest element.

    returns

    the largest element of this Chain.

  84. final def maxBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

    Finds the largest result after applying the given function to every element.

    Finds the largest result after applying the given function to every element.

    returns

    the largest result of applying the given function to every element of this Chain.

  85. final def min[U >: T](implicit cmp: Ordering[U]): T

    Finds the smallest element.

    Finds the smallest element.

    returns

    the smallest element of this Chain.

  86. final def minBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

    Finds the smallest result after applying the given function to every element.

    Finds the smallest result after applying the given function to every element.

    returns

    the smallest result of applying the given function to every element of this Chain.

  87. final def mkString(start: String, sep: String, end: String): String

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

    Displays all elements of this Chain 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 Chain. The resulting string begins with the string start and ends with the string end. Inside, In the resulting string, the result of invoking toString on all elements of this Chain are separated by the string sep.

  88. final def mkString(sep: String): String

    Displays all elements of this Chain in a string using a separator string.

    Displays all elements of this Chain in a string using a separator string.

    sep

    the separator string

    returns

    a string representation of this Chain. In the resulting string, the result of invoking toString on all elements of this Chain are separated by the string sep.

  89. final def mkString: String

    Displays all elements of this Chain in a string.

    Displays all elements of this Chain in a string.

    returns

    a string representation of this Chain. In the resulting string, the result of invoking toString on all elements of this Chain follow each other without any separator string.

  90. final def nonEmpty: Boolean

    Returns true to indicate this Chain, like all Chains, is non-empty.

    Returns true to indicate this Chain, like all Chains, is non-empty.

    returns

    true

  91. final def padTo[U >: T](len: Int, elem: U): Chain[U]

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

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

    len

    the target length

    elem

    he padding value

    returns

    a new Chain consisting of all elements of this Chain followed by the minimal number of occurrences of elem so that the resulting Chain has a length of at least len.

  92. final def patch[U >: T](from: Int, that: Chain[U], replaced: Int): Chain[U]

    Produces a new Chain where a slice of elements in this Chain is replaced by another Chain

    Produces a new Chain where a slice of elements in this Chain is replaced by another Chain

    from

    the index of the first replaced element

    that

    the Chain whose elements should replace a slice in this Chain

    replaced

    the number of elements to drop in the original Chain

  93. final def permutations: Iterator[Chain[T]]

    Iterates over distinct permutations.

    Iterates over distinct permutations.

    Here's an example:

    Chain('a', 'b', 'b').permutations.toList = List(Chain(a, b, b), Chain(b, a, b), Chain(b, b, a))

    returns

    an iterator that traverses the distinct permutations of this Chain.

  94. final def prefixLength(p: (T) ⇒ Boolean): Int

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

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

    p

    the predicate used to test elements.

    returns

    the length of the longest prefix of this Chain such that every element of the segment satisfies the predicate p.

  95. final def product[U >: T](implicit num: Numeric[U]): U

    The result of multiplying all the elements of this Chain.

    The result of multiplying all the elements of this Chain.

    This method can be invoked for any Chain[T] for which an implicit Numeric[T] exists.

    returns

    the product of all elements

  96. final def reduce[U >: T](op: (U, U) ⇒ U): U

    Reduces the elements of this Chain using the specified associative binary operator.

    Reduces the elements of this Chain using the specified associative binary operator.

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

    U

    a type parameter for the binary operator, a supertype of T.

    op

    a binary operator that must be associative.

    returns

    the result of applying reduce operator op between all the elements of this Chain.

  97. final def reduceLeft[U >: T](op: (U, T) ⇒ U): U

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

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

    U

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this Chain, going left to right: 

    op(...op(op(x_1, x_2), x_3), ..., x_n)
    where x1, ..., xn are the elements of this Chain.

  98. final def reduceLeftOption[U >: T](op: (U, T) ⇒ U): Option[U]

    Applies a binary operator to all elements of this Chain, going left to right, returning the result in a Some.

    Applies a binary operator to all elements of this Chain, going left to right, returning the result in a Some.

    U

    the result type of the binary operator.

    op

    the binary operator.

    returns

    a Some containing the result of reduceLeft(op)

  99. final def reduceOption[U >: T](op: (U, U) ⇒ U): Option[U]
  100. final def reduceRight[U >: T](op: (T, U) ⇒ U): U

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

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

    U

    the result of the binary operator

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this Chain, going right to left: 

    op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))
    where x1, ..., xn are the elements of this Chain.

  101. final def reduceRightOption[U >: T](op: (T, U) ⇒ U): Option[U]

    Applies a binary operator to all elements of this Chain, going right to left, returning the result in a Some.

    Applies a binary operator to all elements of this Chain, going right to left, returning the result in a Some.

    U

    the result of the binary operator

    op

    the binary operator

    returns

    a Some containing the result of reduceRight(op)

  102. final def reverse: Chain[T]

    Returns new Chain with elements in reverse order.

    Returns new Chain with elements in reverse order.

    returns

    a new Chain with all elements of this Chain in reversed order.

  103. final def reverseIterator: Iterator[T]

    An iterator yielding elements in reverse order.

    An iterator yielding elements in reverse order.

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

    returns

    an iterator yielding the elements of this Chain in reversed order

  104. final def reverseMap[U](f: (T) ⇒ U): Chain[U]

    Builds a new Chain by applying a function to all elements of this Chain and collecting the results in reverse order.

    Builds a new Chain by applying a function to all elements of this Chain and collecting the results in reverse order.

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

    U

    the element type of the returned Chain.

    f

    the function to apply to each element.

    returns

    a new Chain resulting from applying the given function f to each element of this Chain and collecting the results in reverse order.

  105. final def sameElements[U >: T](that: Chain[U]): Boolean

    Checks if the given Chain contains the same elements in the same order as this Chain.

    Checks if the given Chain contains the same elements in the same order as this Chain.

    that

    the Chain with which to compare

    returns

    true, if both this and the given Chain contain the same elements in the same order, false otherwise.

  106. final def sameElements[U >: T](that: Every[U]): Boolean

    Checks if the given Every contains the same elements in the same order as this Chain.

    Checks if the given Every contains the same elements in the same order as this Chain.

    that

    the Every with which to compare

    returns

    true, if both this and the given Every contain the same elements in the same order, false otherwise.

  107. final def sameElements[U >: T](that: GenIterable[U]): Boolean

    Checks if the given GenIterable contains the same elements in the same order as this Chain.

    Checks if the given GenIterable contains the same elements in the same order as this Chain.

    that

    the GenIterable with which to compare

    returns

    true, if both this Chain and the given GenIterable contain the same elements in the same order, false otherwise.

  108. final def scan[U >: T](z: U)(op: (U, U) ⇒ U): Chain[U]

    Computes a prefix scan of the elements of this Chain.

    Computes a prefix scan of the elements of this Chain.

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

    Here are some examples:

    Chain(1, 2, 3).scan(0)(_ + _) == Chain(0, 1, 3, 6)
Chain(1, 2, 3).scan("z")(_ + _.toString) == Chain("z", "z1", "z12", "z123")

    U

    a type parameter for the binary operator, a supertype of T, and the type of the resulting Chain.

    z

    a neutral element for the scan 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

    a new Chain containing the prefix scan of the elements in this Chain

  109. final def scanLeft[B](z: B)(op: (B, T) ⇒ B): Chain[B]

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

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

    Here are some examples:

    Chain(1, 2, 3).scanLeft(0)(_ + _) == Chain(0, 1, 3, 6)
Chain(1, 2, 3).scanLeft("z")(_ + _) == Chain("z", "z1", "z12", "z123")

    B

    the result type of the binary operator and type of the resulting Chain

    z

    the start value.

    op

    the binary operator.

    returns

    a new Chain containing the intermediate results of inserting op between consecutive elements of this Chain, going left to right, with the start value, z, on the left.

  110. final def scanRight[B](z: B)(op: (T, B) ⇒ B): Chain[B]

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

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

    Here are some examples:

    Chain(1, 2, 3).scanRight(0)(_ + _) == Chain(6, 5, 3, 0)
Chain(1, 2, 3).scanRight("z")(_ + _) == Chain("123z", "23z", "3z", "z")

    B

    the result of the binary operator and type of the resulting Chain

    z

    the start value

    op

    the binary operator

    returns

    a new Chain containing the intermediate results of inserting op between consecutive elements of this Chain, going right to left, with the start value, z, on the right.

  111. final def segmentLength(p: (T) ⇒ Boolean, from: Int): Int

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

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

    p

    the predicate used to test elements.

    from

    the index where the search starts.

  112. final def size: Int

    The size of this Chain.

    The size of this Chain.

    Note: length and size yield the same result, which will be >= 1.

    returns

    the number of elements in this Chain.

  113. final def sliding(size: Int, step: Int): Iterator[Chain[T]]

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

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

    size

    the number of elements per group

    step

    the distance between the first elements of successive groups

    returns

    an iterator producing Chains of size size, except the last and the only element will be truncated if there are fewer elements than size.

  114. final def sliding(size: Int): Iterator[Chain[T]]

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

    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

    returns

    an iterator producing Chains of size size, except the last and the only element will be truncated if there are fewer elements than size.

  115. final def sortBy[U](f: (T) ⇒ U)(implicit ord: Ordering[U]): Chain[T]

    Sorts this Chain according to the Ordering of the result of applying the given function to every element.

    Sorts this Chain according to the Ordering of the result of applying the given function to every element.

    U

    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 U.

    ord

    the ordering assumed on domain U.

    returns

    a Chain consisting of the elements of this Chain sorted according to the Ordering where x < y if ord.lt(f(x), f(y)).

  116. final def sortWith(lt: (T, T) ⇒ Boolean): Chain[T]

    Sorts this Chain according to a comparison function.

    Sorts this Chain according to a comparison function.

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

    returns

    a Chain consisting of the elements of this Chain sorted according to the comparison function lt.

  117. final def sorted[U >: T](implicit ord: Ordering[U]): Chain[U]

    Sorts this Chain according to an Ordering.

    Sorts this Chain 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 Chain as in the original.

    ord

    the Ordering to be used to compare elements.

    returns

    a Chain consisting of the elements of this Chain sorted according to the comparison function lt.

  118. final def startsWith[B](that: Chain[B], offset: Int): Boolean

    Indicates whether this Chain starts with the given Chain at the given index.

    Indicates whether this Chain starts with the given Chain at the given index.

    that

    the Chain slice to look for in this Chain

    offset

    the index at which this Chain is searched.

    returns

    true if this Chain has that as a slice at the index offset, false otherwise.

  119. final def startsWith[B](that: Every[B], offset: Int): Boolean

    Indicates whether this Chain starts with the given Every at the given index.

    Indicates whether this Chain starts with the given Every at the given index.

    that

    the Every slice to look for in this Chain

    offset

    the index at which this Chain is searched.

    returns

    true if this Chain has that as a slice at the index offset, false otherwise.

  120. final def startsWith[B](that: Chain[B]): Boolean

    Indicates whether this Chain starts with the given Chain.

    Indicates whether this Chain starts with the given Chain.

    that

    the Chain to test

    returns

    true if this collection has that as a prefix, false otherwise.

  121. final def startsWith[B](that: Every[B]): Boolean

    Indicates whether this Chain starts with the given Every.

    Indicates whether this Chain starts with the given Every.

    that

    the Every to test

    returns

    true if this collection has that as a prefix, false otherwise.

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

    Indicates whether this Chain starts with the given GenSeq at the given index.

    Indicates whether this Chain starts with the given GenSeq at the given index.

    that

    the GenSeq slice to look for in this Chain

    offset

    the index at which this Chain is searched.

    returns

    true if this Chain has that as a slice at the index offset, false otherwise.

  123. final def startsWith[B](that: GenSeq[B]): Boolean

    Indicates whether this Chain starts with the given GenSeq.

    Indicates whether this Chain starts with the given GenSeq.

    that

    the GenSeq slice to look for in this Chain

    returns

    true if this Chain has that as a prefix, false otherwise.

  124. def stringPrefix: String

    Returns "Chain", the prefix of this object's toString representation.

    Returns "Chain", the prefix of this object's toString representation.

    returns

    the string "Chain"

  125. final def sum[U >: T](implicit num: Numeric[U]): U

    The result of summing all the elements of this Chain.

    The result of summing all the elements of this Chain.

    This method can be invoked for any Chain[T] for which an implicit Numeric[T] exists.

    returns

    the sum of all elements

  126. final def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, T, Col[T]]): Col[T]

    Converts this Chain into a collection of type Col by copying all elements.

    Converts this Chain into a collection of type Col by copying all elements.

    Col

    the collection type to build.

    returns

    a new collection containing all elements of this Chain.

  127. final def toArray[U >: T](implicit classTag: ClassTag[U]): Array[U]

    Converts this Chain to an array.

    Converts this Chain to an array.

    returns

    an array containing all elements of this Chain. A ClassTag must be available for the element type of this Chain.

  128. final def toBuffer[U >: T]: Buffer[U]

    Converts this Chain to a mutable buffer.

    Converts this Chain to a mutable buffer.

    returns

    a buffer containing all elements of this Chain.

  129. final def toIndexedSeq: IndexedSeq[T]

    Converts this Chain to an immutable IndexedSeq.

    Converts this Chain to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this Chain.

  130. final def toIterable: Iterable[T]

    Converts this Chain to an iterable collection.

    Converts this Chain to an iterable collection.

    returns

    an Iterable containing all elements of this Chain.

  131. final def toIterator: Iterator[T]

    Returns an Iterator over the elements in this Chain.

    Returns an Iterator over the elements in this Chain.

    returns

    an Iterator containing all elements of this Chain.

  132. val toList: List[T]
  133. final def toMap[K, V](implicit ev: <:<[T, (K, V)]): Map[K, V]

    Converts this Chain to a map.

    Converts this Chain to a map.

    This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys.

    returns

    a map of type immutable.Map[K, V] containing all key/value pairs of type (K, V) of this Chain.

  134. final def toSeq: Seq[T]

    Converts this Chain to an immutable IndexedSeq.

    Converts this Chain to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this Chain.

  135. final def toSet[U >: T]: Set[U]

    Converts this Chain to a set.

    Converts this Chain to a set.

    returns

    a set containing all elements of this Chain.

  136. final def toStream: Stream[T]

    Converts this Chain to a stream.

    Converts this Chain to a stream.

    returns

    a stream containing all elements of this Chain.

  137. def toString(): String

    Returns a string representation of this Chain.

    Returns a string representation of this Chain.

    returns

    the string "Chain" followed by the result of invoking toString on this Chain's elements, surrounded by parentheses.

    Definition Classes
    Chain → Any
  138. final def toTraversable: Traversable[T]

    Converts this Chain to an unspecified Traversable.

    Converts this Chain to an unspecified Traversable.

    returns

    a Traversable containing all elements of this Chain.

  139. final def toVector: Vector[T]

    Converts this Chain to a Vector.

    Converts this Chain to a Vector.

    returns

    a Vector containing all elements of this Chain.

  140. final def transpose[U](implicit ev: <:<[T, Chain[U]]): Chain[Chain[U]]
  141. final def union[U >: T](that: GenSeq[U])(implicit cbf: CanBuildFrom[List[T], U, List[U]]): Chain[U]

    Produces a new Chain that contains all elements of this Chain and also all elements of a given GenSeq.

    Produces a new Chain that contains all elements of this Chain and also all elements of a given GenSeq.

    chainX union ys is equivalent to chainX ++ ys.

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

    that

    the GenSeq to add.

    returns

    a new Chain that contains all elements of this Chain followed by all elements of that GenSeq.

  142. final def union[U >: T](that: Chain[U]): Chain[U]

    Produces a new Chain that contains all elements of this Chain and also all elements of a given Chain.

    Produces a new Chain that contains all elements of this Chain and also all elements of a given Chain.

    chainX union chainY is equivalent to chainX ++ chainY.

    Another way to express this is that chainX union chainY computes the order-presevring multi-set union of chainX and chainY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

    that

    the Chain to add.

    returns

    a new Chain that contains all elements of this Chain followed by all elements of that.

  143. final def union[U >: T](that: Every[U]): Chain[U]

    Produces a new Chain that contains all elements of this Chain and also all elements of a given Every.

    Produces a new Chain that contains all elements of this Chain and also all elements of a given Every.

    chainX union everyY is equivalent to chainX ++ everyY.

    Another way to express this is that chainX union everyY computes the order-presevring multi-set union of chainX and everyY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

    that

    the Every to add.

    returns

    a new Chain that contains all elements of this Chain followed by all elements of that Every.

  144. final def unzip[L, R](implicit asPair: (T) ⇒ (L, R)): (Chain[L], Chain[R])

    Converts this Chain of pairs into two Chains of the first and second half of each pair.

    Converts this Chain of pairs into two Chains of the first and second half of each pair.

    L

    the type of the first half of the element pairs

    R

    the type of the second half of the element pairs

    asPair

    an implicit conversion that asserts that the element type of this Chain is a pair.

    returns

    a pair of Chains, containing the first and second half, respectively, of each element pair of this Chain.

  145. final def unzip3[L, M, R](implicit asTriple: (T) ⇒ (L, M, R)): (Chain[L], Chain[M], Chain[R])

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

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

    L

    the type of the first member of the element triples

    R

    the type of the third member of the element triples

    asTriple

    an implicit conversion that asserts that the element type of this Chain is a triple.

    returns

    a triple of Chains, containing the first, second, and third member, respectively, of each element triple of this Chain.

  146. final def updated[U >: T](idx: Int, elem: U): Chain[U]

    A copy of this Chain with one single replaced element.

    A copy of this Chain with one single replaced element.

    idx

    the position of the replacement

    elem

    the replacing element

    returns

    a copy of this Chain with the element at position idx replaced by elem.

    Exceptions thrown

    IndexOutOfBoundsException if the passed index is greater than or equal to the length of this Chain

  147. final def zipAll[O, U >: T](other: Iterable[O], thisElem: U, otherElem: O): Chain[(U, O)]

    Returns a Chain formed from this Chain and an iterable collection by combining corresponding elements in pairs.

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

    other

    the Iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this Chain is shorter than that Iterable.

    returns

    a new Chain containing pairs consisting of corresponding elements of this Chain and that. The length of the returned collection is the maximum of the lengths of this Chain and that. If this Chain is shorter than that, thisElem values are used to pad the result. If that is shorter than this Chain, thatElem values are used to pad the result.

  148. final def zipWithIndex: Chain[(T, Int)]

    Zips this Chain with its indices.

    Zips this Chain with its indices.

    returns

    A new Chain containing pairs consisting of all elements of this Chain paired with their index. Indices start at 0.

Inherited from AnyVal

Inherited from Any

Ungrouped