scala.collection.immutable

List

object List extends SeqFactory[List]

This object provides a set of operations to create List values.

Source
List.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. List
  2. SeqFactory
  3. TraversableFactory
  4. GenericSeqCompanion
  5. GenSeqFactory
  6. GenTraversableFactory
  7. GenericCompanion
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Coll = List[_]

    The underlying collection type with unknown element type

    The underlying collection type with unknown element type

    Attributes
    protected[this]
    Definition Classes
    GenericCompanion
  2. class GenericCanBuildFrom[A] extends CanBuildFrom[CC[_], A, CC[A]]

    A generic implementation of the CanBuildFrom trait, which forwards all calls to apply(from) to the genericBuilder method of collection from, and which forwards all calls of apply() to the newBuilder method of this factory.

Value Members

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

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

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

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

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

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

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

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  6. lazy val ReusableCBF: GenericCanBuildFrom[Nothing]

    Definition Classes
    GenTraversableFactory
  7. def apply[A](xs: A*): List[A]

    Creates a list with the specified elements.

    Creates a list with the specified elements.

    A

    the type of the list's elements

    returns

    a new list with elements elems

    Definition Classes
    ListGenericCompanion
  8. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  9. implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, List[A]]

    The standard CanBuildFrom instance for List objects.

    The standard CanBuildFrom instance for List objects. The created value is an instance of class GenericCanBuildFrom, which forwards calls to create a new builder to the genericBuilder method of the requesting collection.

  10. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  11. def concat[A](xss: collection.Traversable[A]*): List[A]

    Concatenates all argument collections into a single list.

    Concatenates all argument collections into a single list.

    xss

    the collections that are to be concatenated.

    returns

    the concatenation of all the collections.

    Definition Classes
    GenTraversableFactory
  12. def empty[A]: List[A]

    An empty collection of type List[A]

    An empty collection of type List[A]

    A

    the type of the list's elements

    Definition Classes
    ListGenericCompanion
  13. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

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

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  15. def fill[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: ⇒ A): List[List[List[List[List[A]]]]]

    Produces a five-dimensional list containing the results of some element computation a number of times.

    Produces a five-dimensional list containing the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    elem

    the element computation

    returns

    A list that contains the results of n1 x n2 x n3 x n4 x n5 evaluations of elem.

    Definition Classes
    GenTraversableFactory
  16. def fill[A](n1: Int, n2: Int, n3: Int, n4: Int)(elem: ⇒ A): List[List[List[List[A]]]]

    Produces a four-dimensional list containing the results of some element computation a number of times.

    Produces a four-dimensional list containing the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    n4

    the number of elements in the 4th dimension

    elem

    the element computation

    returns

    A list that contains the results of n1 x n2 x n3 x n4 evaluations of elem.

    Definition Classes
    GenTraversableFactory
  17. def fill[A](n1: Int, n2: Int, n3: Int)(elem: ⇒ A): List[List[List[A]]]

    Produces a three-dimensional list containing the results of some element computation a number of times.

    Produces a three-dimensional list containing the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    elem

    the element computation

    returns

    A list that contains the results of n1 x n2 x n3 evaluations of elem.

    Definition Classes
    GenTraversableFactory
  18. def fill[A](n1: Int, n2: Int)(elem: ⇒ A): List[List[A]]

    Produces a two-dimensional list containing the results of some element computation a number of times.

    Produces a two-dimensional list containing the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    elem

    the element computation

    returns

    A list that contains the results of n1 x n2 evaluations of elem.

    Definition Classes
    GenTraversableFactory
  19. def fill[A](n: Int)(elem: ⇒ A): List[A]

    Produces a list containing the results of some element computation a number of times.

    Produces a list containing the results of some element computation a number of times.

    n

    the number of elements contained in the list.

    elem

    the element computation

    returns

    A list that contains the results of n evaluations of elem.

    Definition Classes
    GenTraversableFactory
  20. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  21. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  22. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

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

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  24. def iterate[A](start: A, len: Int)(f: (A) ⇒ A): List[A]

    Produces a list containing repeated applications of a function to a start value.

    Produces a list containing repeated applications of a function to a start value.

    start

    the start value of the list

    len

    the number of elements contained inthe list

    f

    the function that's repeatedly applied

    returns

    a list with len values in the sequence start, f(start), f(f(start)), ...

    Definition Classes
    GenTraversableFactory
  25. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  26. def newBuilder[A]: Builder[A, List[A]]

    The default builder for List objects.

    The default builder for List objects.

    A

    the type of the list's elements

    Definition Classes
    ListGenericCompanion
  27. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  28. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  29. def range[T](start: T, end: T, step: T)(implicit arg0: Integral[T]): List[T]

    Produces a list containing equally spaced values in some integer interval.

    Produces a list containing equally spaced values in some integer interval.

    start

    the start value of the list

    end

    the end value of the list (the first value NOT contained)

    step

    the difference between successive elements of the list (must be positive or negative)

    returns

    a list with values start, start + step, ... up to, but excluding end

    Definition Classes
    GenTraversableFactory
  30. def range[T](start: T, end: T)(implicit arg0: Integral[T]): List[T]

    Produces a list containing a sequence of increasing of integers.

    Produces a list containing a sequence of increasing of integers.

    start

    the first element of the list

    end

    the end value of the list (the first value NOT contained)

    returns

    a list with values start, start + 1, ..., end - 1

    Definition Classes
    GenTraversableFactory
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) ⇒ A): List[List[List[List[List[A]]]]]

    Produces a five-dimensional list containing values of a given function over ranges of integer values starting from 0.

    Produces a five-dimensional list containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    f

    The function computing element values

    returns

    A list consisting of elements f(i1, i2, i3, i4, i5) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, 0 <= i4 < n4, and 0 <= i5 < n5.

    Definition Classes
    GenTraversableFactory
  33. def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) ⇒ A): List[List[List[List[A]]]]

    Produces a four-dimensional list containing values of a given function over ranges of integer values starting from 0.

    Produces a four-dimensional list containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    n4

    the number of elements in the 4th dimension

    f

    The function computing element values

    returns

    A list consisting of elements f(i1, i2, i3, i4) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, and 0 <= i4 < n4.

    Definition Classes
    GenTraversableFactory
  34. def tabulate[A](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) ⇒ A): List[List[List[A]]]

    Produces a three-dimensional list containing values of a given function over ranges of integer values starting from 0.

    Produces a three-dimensional list containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3nd dimension

    f

    The function computing element values

    returns

    A list consisting of elements f(i1, i2, i3) for 0 <= i1 < n1, 0 <= i2 < n2, and 0 <= i3 < n3.

    Definition Classes
    GenTraversableFactory
  35. def tabulate[A](n1: Int, n2: Int)(f: (Int, Int) ⇒ A): List[List[A]]

    Produces a two-dimensional list containing values of a given function over ranges of integer values starting from 0.

    Produces a two-dimensional list containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    f

    The function computing element values

    returns

    A list consisting of elements f(i1, i2) for 0 <= i1 < n1 and 0 <= i2 < n2.

    Definition Classes
    GenTraversableFactory
  36. def tabulate[A](n: Int)(f: (Int) ⇒ A): List[A]

    Produces a list containing values of a given function over a range of integer values starting from 0.

    Produces a list containing values of a given function over a range of integer values starting from 0.

    n

    The number of elements in the list

    f

    The function computing element values

    returns

    A list consisting of elements f(0), ..., f(n -1)

    Definition Classes
    GenTraversableFactory
  37. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  38. def unapplySeq[A](x: List[A]): Some[List[A]]

    This method is called in a pattern match { case Seq(.

    This method is called in a pattern match { case Seq(...) => }.

    x

    the selector value

    returns

    sequence wrapped in an option, if this is a Seq, otherwise none

    Definition Classes
    SeqFactory
  39. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def exists2[A, B](xs: List[A], ys: List[B])(f: (A, B) ⇒ Boolean): Boolean

    Tests whether the given predicate p holds for some corresponding elements of the argument lists.

    Tests whether the given predicate p holds for some corresponding elements of the argument lists.

    f

    function to apply to each pair of elements.

    returns

    n != 0 && (p(a0,b0) || ... || p(an,bn))] if the lists are [a0, ..., ak], [b0, ..., bl] and n = min(k,l)

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use (xs, ys).zipped.exists(f) instead of List.exists2(xs, ys)(f)

  2. def flatten[A](xss: List[List[A]]): List[A]

    Concatenate all the elements of a given list of lists.

    Concatenate all the elements of a given list of lists.

    xss

    the list of lists that are to be concatenated

    returns

    the concatenation of all the lists

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xss.flatten instead of List.flatten(xss)

  3. def forall2[A, B](xs: List[A], ys: List[B])(f: (A, B) ⇒ Boolean): Boolean

    Tests whether the given predicate p holds for all corresponding elements of the argument lists.

    Tests whether the given predicate p holds for all corresponding elements of the argument lists.

    f

    function to apply to each pair of elements.

    returns

    (p(a0,b0) && ... && p(an,bn))] if the lists are [a0, ..., ak]; [b0, ..., bl] and n = min(k,l)

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use (xs, ys).zipped.forall(f) instead of List.forall2(xs, ys)(f)

  4. def fromArray[A](arr: Array[A], start: Int, len: Int): List[A]

    Converts a range of an array into a list.

    Converts a range of an array into a list.

    arr

    the array to convert

    start

    the first index to consider

    len

    the length of the range to convert

    returns

    a list that contains the same elements than arr in the same order

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use array.view(start, end).toList instead of List.fromArray(array, start, end)

  5. def fromArray[A](arr: Array[A]): List[A]

    Converts an array into a list.

    Converts an array into a list.

    arr

    the array to convert

    returns

    a list that contains the same elements than arr in the same order

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use array.toList instead of List.fromArray(array)

  6. def fromIterator[A](it: Iterator[A]): List[A]

    Converts an iterator to a list.

    Converts an iterator to a list.

    it

    the iterator to convert

    returns

    a list that contains the elements returned by successive calls to it.next

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use it.toList instead of List.toList(it)

  7. def lefts[A, B](es: collection.Iterable[Either[A, B]]): List[A]

    Returns the Left values in the given Iterable of Eithers.

    Returns the Left values in the given Iterable of Eithers.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xs collect { case Left(x: A) => x } instead of List.lefts(xs)

  8. def make[A](n: Int, elem: A): List[A]

    Create a list containing several copies of an element.

    Create a list containing several copies of an element.

    n

    the length of the resulting list

    elem

    the element composing the resulting list

    returns

    a list composed of n elements all equal to elem

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use fill instead

  9. def map2[A, B, C](xs: List[A], ys: List[B])(f: (A, B) ⇒ C): List[C]

    Returns the list resulting from applying the given function f to corresponding elements of the argument lists.

    Returns the list resulting from applying the given function f to corresponding elements of the argument lists.

    f

    function to apply to each pair of elements.

    returns

    [f(a0,b0), ..., f(an,bn)] if the lists are [a0, ..., ak], [b0, ..., bl] and n = min(k,l)

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use (xs, ys).zipped.map(f) instead of List.map2(xs, ys)(f)

  10. def range(start: Int, end: Int, step: (Int) ⇒ Int): List[Int]

    Create a sorted list with element values v>n+1 = step(vn) where v0 = start and elements are in the range between start (inclusive) and end (exclusive).

    Create a sorted list with element values v>n+1 = step(vn) where v0 = start and elements are in the range between start (inclusive) and end (exclusive).

    start

    the start value of the list

    end

    the end value of the list

    step

    the increment function of the list, which given vn, computes vn+1. Must be monotonically increasing or decreasing.

    returns

    the sorted list of all integers in range [start;end).

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use iterate instead

  11. def rights[A, B](es: collection.Iterable[Either[A, B]]): List[B]

    Returns the Right values in the given Iterable of Eithers.

    Returns the Right values in the given Iterable of Eithers.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xs collect { case Right(x: B) => x } instead of List.rights(xs)

  12. def separate[A, B](es: collection.Iterable[Either[A, B]]): (List[A], List[B])

    Transforms an Iterable of Eithers into a pair of lists.

    Transforms an Iterable of Eithers into a pair of lists.

    es

    the iterable of Eithers to separate

    returns

    a pair of lists.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use (for (Left(x) <- es) yield x, for (Right(x) <- es) yield x) instead

  13. def transpose[A](xss: List[List[A]]): List[List[A]]

    Transposes a list of lists.

    Transposes a list of lists. pre: All element lists have the same length.

    xss

    the list of lists

    returns

    the transposed list of lists

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xss.transpose instead of List.transpose(xss)

  14. def unzip[A, B](xs: collection.Iterable[(A, B)]): (List[A], List[B])

    Transforms an iterable of pairs into a pair of lists.

    Transforms an iterable of pairs into a pair of lists.

    xs

    the iterable of pairs to unzip

    returns

    a pair of lists.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xs.unzip instead of List.unzip(xs)

  15. def unzip[A, B](xs: List[(A, B)]): (List[A], List[B])

    Transforms a list of pairs into a pair of lists.

    Transforms a list of pairs into a pair of lists.

    xs

    the list of pairs to unzip

    returns

    a pair of lists.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use xs.unzip instead of List.unzip(xs)

Inherited from SeqFactory[List]

Inherited from TraversableFactory[List]

Inherited from GenericSeqCompanion[List]

Inherited from GenSeqFactory[List]

Inherited from GenTraversableFactory[List]

Inherited from GenericCompanion[List]

Inherited from AnyRef

Inherited from Any

Ungrouped