PCData

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

Alias for concat.

Type parameters

B: the element type of the returned collection

Value parameters

suffix: the iterable to append to this immutable sequence

Attributes

Inherited from:: IterableOps

Alias for prependedAll.

Attributes

Definition Classes: SeqOps -> IterableOps
Inherited from:: SeqOps

Alias for prepended.

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

Attributes

Returns: a new immutable sequence consisting of elem followed by all elements of this immutable sequence
Inherited from:: SeqOps

Alias for appended.

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

Attributes

Inherited from:: SeqOps

Alias for appendedAll.

Attributes

Inherited from:: SeqOps

Projection function, which returns elements of this sequence based on the string that. Use:

this \ "foo" to get a list of all children that are labelled with "foo";
this \ "_" to get a list of all child elements (wildcard);
this \ "@foo" to get the unprefixed attribute "foo" of this;
this \ "@{uri}foo" to get the prefixed attribute "pre:foo" whose prefix "pre" is resolved to the namespace "uri".

For attribute projections, the resulting scala.xml.NodeSeq attribute values are wrapped in a scala.xml.Group.

There is no support for searching a prefixed attribute by its literal prefix.

The document order is preserved.

Attributes

Inherited from:: NodeSeq

Convenience method which returns string text of the named attribute. Use:

that \@ "foo" to get the string text of attribute "foo";

Attributes

Inherited from:: NodeSeq

Projection function, which returns elements of this sequence and of all its subsequences, based on the string that. Use:

this \\ "foo" to get a list of all elements that are labelled with "foo", includingthis`;
this \\ "_" to get a list of all elements (wildcard), including this;
this \\ "@foo" to get all unprefixed attributes "foo";
this \\ "@{uri}foo" to get all prefixed attribute "pre:foo" whose prefix "pre" is resolved to the namespace "uri".

For attribute projections, the resulting scala.xml.NodeSeq attribute values are wrapped in a scala.xml.Group.

There is no support for searching a prefixed attribute by its literal prefix.

The document order is preserved.

Attributes

Inherited from:: NodeSeq

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

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    val h = a.addString(b) // 1234

Value parameters

b: the string builder to which elements are appended.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps

Appends all elements of this immutable sequence 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 immutable sequence, separated by the string sep.

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b, ", ") // 1, 2, 3, 4

Value parameters

b: the string builder to which elements are appended.
sep: the separator string.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps

Appends all elements of this immutable sequence 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 immutable sequence are separated by the string sep.

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b , "List(" , ", " , ")") // List(1, 2, 3, 4)

Value parameters

b: the string builder to which elements are appended.
end: the ending string.
sep: the separator string.
start: the starting string.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters

C: the result type of the transformation function.

Value parameters

k: the transformation function

Attributes

Returns: a partial function with the domain of this partial function narrowed by other partial function, which maps arguments x to k(this(x)).
Inherited from:: PartialFunction

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

If the runtime type of the function is a PartialFunction then the other andThen method is used (note its cautions).

Type parameters

C: the result type of the transformation function.

Value parameters

k: the transformation function

Attributes

Returns: a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments x to k(this(x)).
Definition Classes: PartialFunction -> Function1
Inherited from:: PartialFunction

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

A copy of this immutable sequence with an element appended.

Note: will not terminate for infinite-sized collections.

Example:

  val a = List(1)
  val b = a :+ 2
  // a is still List(1), b is List(1, 2)

@tparam B the element type of the returned immutable sequence. @param elem the appended element @return a new immutable sequence consisting of all elements of this immutable sequence followed by elem.

Attributes

Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

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

Type parameters

B: the element type of the returned collection.

Value parameters

suffix: the iterable to append.

Attributes

Returns: a new collection of type CC[B] which contains all elements of this immutable sequence followed by all elements of suffix.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Attributes

Inherited from:: NodeSeq

Gets the element at the specified index. This operation is provided for convenience in Seq. It should not be assumed to be efficient unless you have an IndexedSeq.

Value parameters

i: the index of the element to retrieve, zero-based

Attributes

Definition Classes: NodeSeq -> SeqOps -> Function1
Inherited from:: NodeSeq

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.

@param x the function argument @param default the fallback function @return the result of this function or fallback function application.

Attributes

Inherited from:: PartialFunction

Convenience method, looks up a prefixed attribute in attributes of this node. Same as attributes.getValue(uri, this, key)-

Value parameters

key: of queried attribute.
uri: namespace of queried attribute (may not be null).

Attributes

Returns: value of PrefixedAttribute with given namespace and given key, otherwise '''null'''.
Inherited from:: Node

Convenience method, looks up an unprefixed attribute in attributes of this node. Same as attributes.getValue(key)

Value parameters

key: of queried attribute.

Attributes

Returns: value of UnprefixedAttribute with given key in attributes, if it exists, otherwise null.
Inherited from:: Node

always empty

Attributes

Definition Classes: SpecialNode -> Node
Inherited from:: SpecialNode

String representation of this node

Value parameters

stripComments: if true, strips comment nodes from result

Attributes

Inherited from:: Node

We insist we're only equal to other xml.Equality implementors, which heads off a lot of inconsistency up front.

Attributes

Definition Classes: Atom -> Node -> NodeSeq -> Equality -> Seq -> Equals
Inherited from:: Atom

always empty

Attributes

Definition Classes: SpecialNode -> Node -> ScalaVersionSpecificNode
Inherited from:: SpecialNode

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

Type parameters

B: the element type of the returned immutable sequence.

Value parameters

pf: the partial function which filters and maps the immutable sequence.

Attributes

Returns: a new immutable sequence 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: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Finds the first element of the immutable sequence for which the given partial function is defined, and applies the partial function to it.

Note: may not terminate for infinite-sized collections.

Type parameters

B: the result type of the partial function

Value parameters

pf: the partial function

Attributes

Returns: an option value containing pf applied to the first value for which it is defined, or None if none exists.
Example: Seq("a", 1, 5L).collectFirst { case x: Int => x*10 } = Some(10)
Inherited from:: IterableOnceOps

Iterates over combinations of elements.

A combination of length n is a sequence of n elements selected in order of their first index in this sequence.

For example, "xyx" has two combinations of length 2. The x is selected first: "xx", "xy". The sequence "yx" is not returned as a combination because it is subsumed by "xy".

If there is more than one way to generate the same combination, only one will be returned.

For example, the result "xy" arbitrarily selected one of the x elements.

As a further illustration, "xyxx" has three different ways to generate "xy" because there are three elements x to choose from. Moreover, there are three unordered pairs "xx" but only one is returned.

It is not specified which of these equal combinations is returned. It is an implementation detail that should not be relied on. For example, the combination "xx" does not necessarily contain the first x in this sequence. This behavior is observable if the elements compare equal but are not identical.

As a consequence, "xyx".combinations(3).next() is "xxy": the combination does not reflect the order of the original sequence, but the order in which elements were selected, by "first index"; the order of each x element is also arbitrary.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n: the number of elements in each combination

Attributes

Returns

An Iterator which traverses the n-element combinations of this immutable sequence.

Example

  Seq('a', 'b', 'b', 'b', 'c').combinations(2).foreach(println)
  // List(a, b)
  // List(a, c)
  // List(b, b)
  // List(b, c)
  Seq('b', 'a', 'b').combinations(2).foreach(println)
  // List(b, b)
  // List(b, a)

Inherited from:

SeqOps

Composes another partial function k with this partial function so that this partial function gets applied to results of k.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters

R: the parameter type of the transformation function.

Value parameters

k: the transformation function

Attributes

Returns: a partial function with the domain of other partial function narrowed by this partial function, which maps arguments x to this(k(x)).
Inherited from:: PartialFunction

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

Type parameters

A: the type to which function g can be applied

Value parameters

g: a function A => T1

Attributes

Returns: a new function f such that f(x) == apply(g(x))
Inherited from:: Function1

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

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

Type parameters

B: the element type of the returned collection.

Value parameters

suffix: the iterable to append.

Attributes

Returns: a new immutable sequence which contains all elements of this immutable sequence followed by all elements of suffix.
Definition Classes: SeqOps -> IterableOps
Inherited from:: SeqOps

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

Note: may not terminate for infinite-sized collections.

Type parameters

A1: the type of the element to test (a supertype of A)

Value parameters

elem: the element to test.

Attributes

Returns: true if this immutable sequence has an element that is equal (as determined by ==) to elem, false otherwise.
Inherited from:: SeqOps

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

Note: may not terminate for infinite-sized collections.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

that: the sequence to test

Attributes

Returns: true if this immutable sequence contains a slice with the same elements as that, otherwise false.
Inherited from:: SeqOps

Copies elements to an array and returns the number of elements written.

Fills the given array dest starting at index start with at most n elements of this immutable sequence.

Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached, or n elements have been copied.

If start is less than zero, it is taken as zero.

Type parameters

B: the type of the elements of the array.

Value parameters

dest: the array to fill.
n: the maximal number of elements to copy.
start: the starting index of xs.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps

Copies elements to an array, returning the number of elements written.

Fills the given array dest starting at index start with values of this immutable sequence.

Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached.

Type parameters

B: the type of the elements of the array.

Value parameters

dest: the array to fill.
start: the starting index of xs.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps

Copies elements to an array, returning the number of elements written.

Fills the given array dest starting at index start with values of this immutable sequence.

Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached.

Type parameters

B: the type of the elements of the array.

Value parameters

dest: the array to fill.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the type of the elements of that

Value parameters

p: the test predicate, which relates elements from both collections
that: the other collection

Attributes

Returns: true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false
Inherited from:: IterableOnceOps

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

Type parameters

B: the type of the elements of that

Value parameters

p: the test predicate, which relates elements from both sequences
that: the other sequence

Attributes

Returns: true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this immutable sequence and y of that, otherwise false.
Inherited from:: SeqOps

Counts the number of elements in the immutable sequence which satisfy a predicate.

Note: will not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: the number of elements satisfying the predicate p.
Inherited from:: IterableOnceOps

Descendant axis (all descendants of this node, not including node itself) includes all text nodes, element nodes, comments and processing instructions.

Attributes

Inherited from:: Node

Descendant axis (all descendants of this node, including this node) includes all text nodes, element nodes, comments and processing instructions.

Attributes

Inherited from:: Node

Computes the multiset difference between this immutable sequence and another sequence.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

that: the sequence of elements to remove

Attributes

Returns: a new immutable sequence which contains all elements of this immutable sequence except some of the 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: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Selects all the elements of this immutable sequence ignoring the duplicates.

Attributes

Returns: a new immutable sequence consisting of all the elements of this immutable sequence without duplicates.
Inherited from:: SeqOps

Selects all the elements of this immutable sequence ignoring the duplicates as determined by == after applying the transforming function f.

Type parameters

B: the type of the elements after being transformed by f

Value parameters

f: The transforming function whose result is used to determine the uniqueness of each element

Attributes

Returns: a new immutable sequence consisting of all the elements of this immutable sequence without duplicates.
Definition Classes: StrictOptimizedSeqOps -> StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

The logic formerly found in typeTag$, as best I could infer it.

Attributes

Definition Classes: Atom -> Node
Inherited from:: Atom

Attributes

Definition Classes: Atom -> Node
Inherited from:: Atom

Selects all elements except the first n ones.

Value parameters

n: the number of elements to drop from this immutable sequence.

Attributes

Returns: a immutable sequence consisting of all elements of this immutable sequence except the first n ones, or else the empty immutable sequence, if this immutable sequence has less than n elements. If n is negative, don't drop any elements.
Inherited from:: IterableOps

The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n: the number of elements to drop from the end of this collection

Attributes

Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this immutable sequence, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire immutable sequence.

Example:

    List(1, 2, 3, 100, 4).dropWhile(n => n < 10) // List(100, 4)
    List(1, 2, 3, 100, 4).dropWhile(n => n == 0) // List(1, 2, 3, 100, 4)

Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

Value parameters

p: The predicate used to test elements.

Attributes

Returns: the longest suffix of this immutable sequence whose first element does not satisfy the predicate p.
Inherited from:: IterableOps

Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

Attributes

Example

         val firstChar: String => Option[Char] = _.headOption
         Seq("foo", "bar", "baz") match {
           case firstChar.unlift.elementWise(c0, c1, c2) =>
             println(s"$c0, $c1, $c2") // Output: f, b, b
         }

Inherited from:

PartialFunction

The empty immutable sequence.

Attributes

Returns: an empty iterable of type immutable.Seq .
Definition Classes: ScalaVersionSpecificNodeSeq -> IterableOps
Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

Tests whether this immutable sequence ends with the given sequence.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

that: the sequence to test

Attributes

Returns: true if this immutable sequence has that as a suffix, false otherwise.
Inherited from:: SeqOps

Checks whether this instance is equal to that. This universal equality method is defined in AnyRef.

Attributes

Definition Classes: Equality -> Equals -> Any
Inherited from:: Equality

Tests whether a predicate holds for at least one element of this immutable sequence.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: true if the given predicate p is satisfied by at least one element of this immutable sequence, otherwise false
Inherited from:: IterableOnceOps

Selects all elements of this immutable sequence which satisfy a predicate.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: a new immutable sequence consisting of all elements of this immutable sequence that satisfy the given predicate p. The order of the elements is preserved.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Selects all elements of this immutable sequence which do not satisfy a predicate.

Value parameters

pred: the predicate used to test elements.

Attributes

Returns: a new immutable sequence consisting of all elements of this immutable sequence that do not satisfy the given predicate pred. Their order may not be preserved.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Finds the first element of the immutable sequence satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: an option value containing the first element in the immutable sequence that satisfies p, or None if none exists.
Inherited from:: IterableOnceOps

Finds the last element of the immutable sequence satisfying a predicate, if any.

Note: will not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: an option value containing the last element in the immutable sequence that satisfies p, or None if none exists.
Inherited from:: SeqOps

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

Builds a new immutable sequence by applying a function to all elements of this immutable sequence 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 this immutable sequence. 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)

    // lettersOf2 will return a Set[Char], not a Seq
    def lettersOf2(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)

Type parameters

B: the element type of the returned collection.

Value parameters

f: the function to apply to each element.

Attributes

Returns: a new immutable sequence resulting from applying the given collection-valued function f to each element of this immutable sequence and concatenating the results.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Given that the elements of this collection are themselves iterable collections, converts this immutable sequence into a immutable sequence comprising the elements of these iterable collections.

The resulting collection's type will be guided by the type of immutable sequence. 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)

Type parameters

B: the type of the elements of each iterable collection.

Value parameters

asIterable: an implicit conversion which asserts that the element type of this immutable sequence is an Iterable.

Attributes

Returns: a new immutable sequence resulting from concatenating all element collections.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Applies the given binary operator op to the given initial value z and all elements of this immutable sequence.

For each application of the operator, each operand is either an element of this immutable sequence, the initial value, or another such application of the operator.

        The order of applications of the operator is unspecified and may be nondeterministic.
        Each element appears exactly once in the computation.

The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative. In either case, it is also necessary that the initial value

be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

Note: will not terminate for infinite-sized collections.

Type parameters

A1: The type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.
z: An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

Attributes

Returns: The result of applying op between all the elements and z, or z if this immutable sequence is empty.
Inherited from:: IterableOnceOps

Applies the given binary operator op to the given initial value z and all elements of this immutable sequence, going left to right. Returns the initial value if this immutable sequence is empty.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable sequence, the result is op( op( ... op( op(z, x,,1,,), x,,2,,) ... ), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this immutable sequence and the initial value all appear exactly once in the computation.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator.

Value parameters

op: A binary operator.
z: An initial value.

Attributes

Returns: The result of applying op to z and all elements of this immutable sequence, going left to right. Returns z if this immutable sequence is empty.
Inherited from:: IterableOnceOps

Applies the given binary operator op to all elements of this immutable sequence and the given initial value z, going right to left. Returns the initial value if this immutable sequence is empty.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable sequence, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n,,, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this immutable sequence and the initial value all appear exactly once in the computation.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator.

Value parameters

op: A binary operator.
z: An initial value.

Attributes

Returns: The result of applying op to all elements of this immutable sequence and z, going right to left. Returns z if this immutable sequence is empty.
Inherited from:: IterableOnceOps

Tests whether a predicate holds for all elements of this immutable sequence.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: true if this immutable sequence is empty or the given predicate p holds for all elements of this immutable sequence, otherwise false.
Inherited from:: IterableOnceOps

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Type parameters

U: the return type of f; the value is discarded, but the type parameter aids type inference

Value parameters

f: the function to apply to each element for its side effects

Attributes

Inherited from:: IterableOnceOps

Defines how to turn a given Iterable[A] into a collection of type C.

This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.

Value parameters

coll: the source collection to convert

Attributes

Returns: a new collection of type C containing the elements of coll
Note: When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as it is called with an Iterable[A] obtained from this collection (as it is the case in the implementations of operations where we use a View[A]), it is safe.
Definition Classes: ScalaVersionSpecificNodeSeq -> IterableOps
Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

Convenience method, same as scope.getURI(pre) but additionally checks if scope is '''null'''.

Value parameters

pre: the prefix whose namespace name we would like to obtain

Attributes

Returns: the namespace if scope != null and prefix was found, else null
Inherited from:: Node

Partitions this immutable sequence into a map of immutable sequences according to some discriminator function.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

K: the type of keys returned by the discriminator function.

Value parameters

f: the discriminator function.

Attributes

Returns

A map from keys to immutable sequences 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 immutable sequence of those elements `x`
         for which `f(x)` equals `k`.

Inherited from:

IterableOps

Partitions this immutable sequence into a map of immutable sequences according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

 case class User(name: String, age: Int)

 def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
   users.groupMap(_.age)(_.name)

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B: the type of values returned by the transformation function
K: the type of keys returned by the discriminator function

Value parameters

f: the element transformation function
key: the discriminator function

Attributes

Returns: a map associating each key k produced by key with a immutable sequence of values produced by applying f to elements that map to k
Inherited from:: IterableOps

Partitions this immutable sequence into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

 def occurrences[A](as: Seq[A]): Map[A, Int] =
   as.groupMapReduce(identity)(_ => 1)(_ + _)

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B: the type of values returned by the transformation function
K: the type of keys returned by the discriminator function

Value parameters

f: the element transformation function
key: the discriminator function
reduce: the reduction function used to combine values mapped to the same key

Attributes

Inherited from:: IterableOps

Partitions elements in fixed size immutable sequences.

Value parameters

size: the number of elements per group

Attributes

Returns: An iterator producing immutable sequences of size size, except the last will be less than size size if the elements don't divide evenly.
See also: scala.collection.Iterator, method grouped
Inherited from:: IterableOps

It's be nice to make these final, but there are probably people out there subclassing the XML types, especially when it comes to equals. However WE at least can pretend they are final since clearly individual classes cannot be trusted to maintain a semblance of order.

Attributes

Definition Classes: Equality -> Any
Inherited from:: Equality

Selects the first element of this immutable sequence.

Attributes

Returns: the first element of this immutable sequence.
Throws: NoSuchElementException
if the immutable sequence is empty.
Inherited from:: IterableOps

Optionally selects the first element.

Attributes

Returns: the first element of this immutable sequence if it is nonempty, None if it is empty.
Inherited from:: IterableOps

Finds index of first occurrence of some value in this immutable sequence.

Type parameters

B: the type of the element elem.

Value parameters

elem: the element value to search for.

Attributes

Returns: the index >= 0 of the first element of this immutable sequence that is equal (as determined by ==) to elem, or -1, if none exists.
Inherited from:: SeqOps

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

Type parameters

B: the type of the element elem.

Value parameters

elem: the element value to search for.
from: the start index

Attributes

Returns: the index >= from of the first element of this immutable sequence that is equal (as determined by ==) to elem, or -1, if none exists.
Inherited from:: SeqOps

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

Note: may not terminate for infinite-sized collections.

Value parameters

that: the sequence to test

Attributes

Returns: the first index >= 0 such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Inherited from:: SeqOps

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

Note: may not terminate for infinite-sized collections.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

from: the start index
that: the sequence to test

Attributes

Returns: the first index >= from such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Inherited from:: SeqOps

Finds index of the first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: the index >= 0 of the first element of this immutable sequence that satisfies the predicate p, or -1, if none exists.
Inherited from:: SeqOps

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

Note: may not terminate for infinite-sized collections.

Value parameters

from: the start index
p: the predicate used to test elements.

Attributes

Returns: the index >= from of the first element of this immutable sequence that satisfies the predicate p, or -1, if none exists.
Inherited from:: SeqOps

Produces the range of all indices of this sequence.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns: a Range value from 0 to one less than the length of this immutable sequence.
Inherited from:: SeqOps

The initial part of the collection without its last element.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Inherited from:: IterableOps

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

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns: an iterator over all the inits of this immutable sequence
Example: List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Inherited from:: IterableOps

Computes the multiset intersection between this immutable sequence and another sequence.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

that: the sequence of elements to intersect with.

Attributes

Returns: a new immutable sequence which contains all elements of this immutable sequence 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: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

used internally. Atom/Molecule = -1 PI = -2 Comment = -3 EntityRef = -5

Attributes

Inherited from:: Node

Tests whether this immutable sequence contains given index.

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

Value parameters

idx: the index to test

Attributes

Returns: true if this immutable sequence contains an element at position idx, false otherwise.
Inherited from:: SeqOps

Tests whether the immutable sequence is empty.

Note: The default implementation creates and discards an iterator.

Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.

Attributes

Returns: true if the immutable sequence contains no elements, false otherwise.
Definition Classes: SeqOps -> IterableOnceOps
Inherited from:: SeqOps

Tests whether this immutable sequence can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns: true if it is repeatedly traversable, false otherwise.
Definition Classes: IterableOps -> IterableOnceOps
Inherited from:: IterableOps

The companion object of this immutable sequence, providing various factory methods.

Attributes

Returns: the companion factory object for this collection type
Note: When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).
Definition Classes: Seq -> Seq -> Iterable -> Iterable -> IterableOps
Inherited from:: Seq

An scala.collection.Iterator over the elements of this immutable sequence.

If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.

Attributes

Returns: an iterator over all elements of this immutable sequence
Definition Classes: NodeSeq -> IterableOnce
Inherited from:: NodeSeq

The number of elements in this immutable sequence, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Attributes

Inherited from:: IterableOnce

label of this node. I.e. "foo" for <foo/>)

Attributes

Definition Classes: Atom -> Node
Inherited from:: Atom

Selects the last element.

Attributes

Returns: The last element of this immutable sequence.
Throws: NoSuchElementException
If the immutable sequence is empty.
Inherited from:: IterableOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: the type of the element elem.

Value parameters

elem: the element value to search for.
end: the end index.

Attributes

Returns: the index <= end of the last element of this immutable sequence that is equal (as determined by ==) to elem, or -1, if none exists.
Inherited from:: SeqOps

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

Note: will not terminate for infinite-sized collections.

Value parameters

that: the sequence to test

Attributes

Returns: the last index such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Inherited from:: SeqOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

end: the end index
that: the sequence to test

Attributes

Returns: the last index <= end such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Inherited from:: SeqOps

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: the index of the last element of this immutable sequence that satisfies the predicate p, or -1, if none exists.
Inherited from:: SeqOps

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

Note: will not terminate for infinite-sized collections.

Value parameters

end: the maximum index to consider (inclusive)
p: the predicate used to test elements.

Attributes

Returns: the index <= end of the last element of this immutable sequence that satisfies the predicate p, or -1, if none exists.
Inherited from:: SeqOps

Optionally selects the last element.

Attributes

Returns: the last element of this immutable sequence if it is nonempty, None if it is empty.
Inherited from:: IterableOps

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

  val xs = List(1, 2, 3)
  val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
  // res == List(4, 8, 12)

Type parameters

B: the type of the second element in each eventual pair

Value parameters

that: the iterable providing the second element of each eventual pair

Attributes

Returns: a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.
Inherited from:: Iterable

The length (number of elements) of the immutable sequence. size is an alias for length in Seq collections.

Attributes

Definition Classes: NodeSeq -> SeqOps
Inherited from:: NodeSeq

Compares the length of this immutable sequence to the size of another Iterable.

Value parameters

that: the Iterable whose size is compared with this immutable sequence's length.

Attributes

Returns

A value x where

      x <  0       if this.length <  that.size
      x == 0       if this.length == that.size
      x >  0       if this.length >  that.size

The method as implemented here does not call length or size directly; its running time is O(this.length min that.size) instead of O(this.length + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

Inherited from:

SeqOps

Compares the length of this immutable sequence to a test value.

Value parameters

len: the test value that gets compared with the length.

Attributes

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 overridden if computing length is cheap and knownSize returns -1.

See also

lengthIs

Inherited from:

SeqOps

Returns a value class containing operations for comparing the length of this immutable sequence to a test value.

These operations are implemented in terms of `lengthCompare(Int)`, and allow the following more readable usages:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0

Attributes

Returns: an object providing =, and > operations for comparing the length
Inherited from:: SeqOps

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

Attributes

Returns: a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.
See also: Function.unlift
Inherited from:: PartialFunction

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

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

Type parameters

B: the element type of the returned immutable sequence .

Value parameters

f: the function to apply to each element.

Attributes

Returns: a new immutable sequence resulting from applying the given function f to each element of this immutable sequence and collecting the results.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: the largest element of this immutable sequence with respect to the ordering ord.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

f: The measuring function.
ord: An ordering to be used for comparing elements.

Attributes

Returns: the first element of this immutable sequence with the largest value measured by function f with respect to the ordering ord.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

f: The measuring function.
ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the first element of this immutable sequence with the largest value measured by function f with respect to the ordering ord.
Inherited from:: IterableOnceOps

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the largest element of this immutable sequence with respect to the ordering ord.
Inherited from:: IterableOnceOps

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: the smallest element of this immutable sequence with respect to the ordering ord.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

f: The measuring function.
ord: An ordering to be used for comparing elements.

Attributes

Returns: the first element of this immutable sequence with the smallest value measured by function f with respect to the ordering ord.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

f: The measuring function.
ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the first element of this immutable sequence with the smallest value measured by function f with respect to the ordering ord.
Inherited from:: IterableOnceOps

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the smallest element of this immutable sequence with respect to the ordering ord.
Inherited from:: IterableOnceOps

Displays all elements of this immutable sequence in a string.

Delegates to addString, which can be overridden.

Attributes

Returns: a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable sequence follow each other without any separator string.
Inherited from:: IterableOnceOps

Displays all elements of this immutable sequence in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters

sep: the separator string.

Attributes

Returns: a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable sequence are separated by the string sep.
Example: List(1, 2, 3).mkString("|") = "1|2|3"
Inherited from:: IterableOnceOps

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

Delegates to addString, which can be overridden.

Value parameters

end: the ending string.
sep: the separator string.
start: the starting string.

Attributes

Returns: a string representation of this immutable sequence. 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 immutable sequence are separated by the string sep.
Example: List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Inherited from:: IterableOnceOps

Appends qualified name of this node to StringBuilder.

Attributes

Inherited from:: Node

always Node.EmptyNamespace - TODO not really: Node.EmptyNamespace is "", but this is null.

Attributes

Definition Classes: SpecialNode -> Node
Inherited from:: SpecialNode

Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList),

Attributes

Returns: a strict builder for the same collection type. it is possible to implement this method but the resulting Builder will break laziness. As a consequence, operations should preferably be implemented with fromSpecific instead of this method.
Note: When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as the returned builder is only fed with A values taken from this instance, it is safe.
Definition Classes: ScalaVersionSpecificNodeSeq -> IterableOps
Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

Tests whether the immutable sequence is not empty.

Attributes

Returns: true if the immutable sequence contains at least one element, false otherwise.
Inherited from:: IterableOnceOps

Children which do not stringify to "" (needed for equality)

Attributes

Inherited from:: Node

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

Type parameters

A1: the argument type of the fallback function
B1: the result type of the fallback function

Value parameters

that: the fallback function

Attributes

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.
Inherited from:: PartialFunction

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

Type parameters

B: the element type of the returned immutable sequence.

Value parameters

elem: the padding value
len: the target length

Attributes

Returns: a new immutable sequence consisting of all elements of this immutable sequence followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

The two immutable sequence correspond to the result of filter and filterNot, respectively.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Value parameters

p: the predicate used to test elements

Attributes

Returns: a pair of immutable sequences: the first containing all elements that satisfy p, the second containing those that do not
Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

Applies a function f to each element of the immutable sequence and returns a pair of immutable sequences: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

  val xs = $Coll(1, "one", 2, "two", 3, "three") partitionMap {
   case i: Int => Left(i)
   case s: String => Right(s)
  }
  // xs == ($Coll(1, 2, 3),
  //        $Coll(one, two, three))

Type parameters

A1: the element type of the first resulting collection
A2: the element type of the second resulting collection

Value parameters

f: the 'split function' mapping the elements of this immutable sequence to an scala.util.Either

Attributes

Returns: a pair of immutable sequences: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.
Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

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

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original immutable sequence appends the patch to the end. If the replaced count would exceed the available elements, the difference in excess is ignored.

Type parameters

B: the element type of the returned immutable sequence.

Value parameters

from: the index of the first replaced element
other: the replacement sequence
replaced: the number of elements to drop in the original immutable sequence

Attributes

Returns: a new immutable sequence consisting of all elements of this immutable sequence except that replaced elements starting from from are replaced by all the elements of other.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Iterates over distinct permutations of elements.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

An Iterator which traverses the distinct permutations of this immutable sequence.

Example

  Seq('a', 'b', 'b').permutations.foreach(println)
  // List(a, b, b)
  // List(b, a, b)
  // List(b, b, a)

Inherited from:

SeqOps

prefix of this node

Attributes

Inherited from:: Node

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

A copy of the immutable sequence with an element prepended.

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

Example:

    val x = List(1)
    val y = 2 +: x
    // x is still List(1), y is List(2, 1)

Type parameters

B: the element type of the returned immutable sequence.

Value parameters

elem: the prepended element

Attributes

Returns: a new immutable sequence consisting of elem followed by all elements of this immutable sequence.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Attributes

Inherited from:: ScalaVersionSpecificNodeSeq (hidden)

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.

Type parameters

B: the element type of the returned collection.

Value parameters

prefix: the iterable to prepend.

Attributes

Returns: a new immutable sequence which contains all elements of prefix followed by all the elements of this immutable sequence.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Multiplies together the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the result type of the * operator.

Value parameters

num: an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

Attributes

Returns: the product of all elements of this immutable sequence with respect to the * operator in num.
Inherited from:: IterableOnceOps

Applies the given binary operator op to all elements of this immutable sequence.

For each application of the operator, each operand is either an element of this immutable sequence or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns: The result of applying op between all the elements if the immutable sequence is nonempty.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

Applies the given binary operator op to all elements of this immutable sequence, going left to right.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable sequence, the result is op( op( op( ... op(x,,1,,, x,,2,,) ... ), x,,n-1,,), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this immutable sequence and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of applying op to all elements of this immutable sequence, going left to right.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

If this immutable sequence is nonempty, reduces it with the given binary operator op, going left to right.

The behavior is the same as reduceLeft except that the value is None if the immutable sequence is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of reducing this immutable sequence with op going left to right if the immutable sequence is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps

If this immutable sequence is nonempty, reduces it with the given binary operator op.

The behavior is the same as reduce except that the value is None if the immutable sequence is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: A type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns: The result of reducing this immutable sequence with op if the immutable sequence is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps

Applies the given binary operator op to all elements of this immutable sequence, going right to left.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable sequence, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n-1,,, x,,n,,) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this immutable sequence and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of applying op to all elements of this immutable sequence, going right to left.
Throws: UnsupportedOperationException
if this immutable sequence is empty.
Inherited from:: IterableOnceOps

If this immutable sequence is nonempty, reduces it with the given binary operator op, going right to left.

The behavior is the same as reduceRight except that the value is None if the immutable sequence is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of reducing this immutable sequence with op going right to left if the immutable sequence is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps

Returns a new immutable sequence with the elements of this immutable sequence in reverse order.

Note: will not terminate for infinite-sized collections.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns: a new immutable sequence with all elements of this immutable sequence in reverse order.
Inherited from:: SeqOps

An iterator yielding the elements of this immutable sequence in reverse order.

Note: will not terminate for infinite-sized collections.

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

Attributes

Returns: an iterator yielding the elements of this immutable sequence in reverse order.
Inherited from:: SeqOps

Attributes

Inherited from:: IterableOnceOps

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. @see applyOrElse.

@param action the action function @return a function which maps arguments x to isDefinedAt(x). The resulting function runs action(this(x)) where this is defined.

Attributes

Inherited from:: PartialFunction

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this immutable sequence.

Type parameters

B: the type of the elements of collection that.

Value parameters

that: the collection to compare

Attributes

Returns: true if both collections contain equal elements in the same order, false otherwise.
Inherited from:: SeqOps

Computes a prefix scan of the elements of the collection.

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

Type parameters

B: element type of the resulting collection

Value parameters

op: the associative operator for the scan
z: neutral element for the operator op

Attributes

Returns: a new immutable sequence containing the prefix scan of the elements in this immutable sequence
Inherited from:: IterableOps

Produces a immutable sequence containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the type of the elements in the resulting collection

Value parameters

op: the binary operator applied to the intermediate result and the element
z: the initial value

Attributes

Returns: collection with intermediate results
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

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: Even when applied to a view or a lazy collection it will always force the elements.

Example:

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

Type parameters

B: the type of the elements in the resulting collection

Value parameters

op: the binary operator applied to the intermediate result and the element
z: the initial value

Attributes

Returns: collection with intermediate results
Inherited from:: IterableOps

method returning the namespace bindings of this node. by default, this is TopScope, which means there are no namespace bindings except the predefined one for "xml".

Attributes

Inherited from:: Node

Searches within an interval in this sorted sequence for a specific element. If this sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Type parameters

B: the element type used for searching and ordering (a supertype of A)

Value parameters

elem: the element to find.
from: the index where the search starts.
ord: the ordering to be used to compare elements.
to: the index following where the search ends.

Attributes

Returns: a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.
See also: scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, method sorted
Note: if to <= from, the search space is empty, and an InsertionPoint at from is returned
Inherited from:: SeqOps

Searches this sorted sequence for a specific element. If the sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Type parameters

B: the element type used for searching and ordering (a supertype of A)

Value parameters

elem: the element to find.
ord: the ordering to be used to compare elements.

Attributes

Returns: a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.
See also: scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, method sorted
Inherited from:: SeqOps

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

from: the index where the search starts.
p: the predicate used to test elements.

Attributes

Returns: the length of the longest segment of this immutable sequence starting from index from such that every element of the segment satisfies the predicate p.
Inherited from:: SeqOps

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: the length of the longest segment of this immutable sequence that starts from the first element such that every element of the segment satisfies the predicate p.
Inherited from:: SeqOps

The size of this immutable sequence.

Note: will not terminate for infinite-sized collections.

Attributes

Returns: the number of elements in this immutable sequence.
Definition Classes: SeqOps -> IterableOnceOps
Inherited from:: SeqOps

Compares the size of this immutable sequence to the size of another Iterable.

Value parameters

that: the Iterable whose size is compared with this immutable sequence's size.

Attributes

Returns

A value x where

     x <  0       if this.size <  that.size
     x == 0       if this.size == that.size
     x >  0       if this.size >  that.size

The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

Definition Classes

SeqOps -> IterableOps

Inherited from:

SeqOps

Compares the size of this immutable sequence to a test value.

Value parameters

otherSize: the test value that gets compared with the size.

Attributes

Returns

A value x where

     x <  0       if this.size <  otherSize
     x == 0       if this.size == otherSize
     x >  0       if this.size >  otherSize

The default implementation does not call size, which may be arbitrarily expensive. It will use knownSize if nonnegative. Otherwise, it will iterate to compute an element count, with complexity O(size min otherSize). This method should be overridden if computing size is cheap and knownSize returns -1. In that case, the custom implementation should just compare size and otherSize directly.

See also

sizeIs

Definition Classes

SeqOps -> IterableOps

Inherited from:

SeqOps

Returns a value class containing operations for comparing the size of this immutable sequence to a test value.

These operations are implemented in terms of `sizeCompare(Int)`, and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0

Attributes

Returns: a wrapper that allows size comparisons using operators such as =, and >
Inherited from:: IterableOps

Selects an interval of elements. The returned immutable sequence is made up of all elements x which satisfy the invariant:

  from <= indexOf(x) < until

Value parameters

from: the lowest index to include from this immutable sequence.
until: the lowest index to EXCLUDE from this immutable sequence.

Attributes

Returns: a immutable sequence containing the elements greater than or equal to index from extending up to (but not including) index until of this immutable sequence.
Example: List('a', 'b', 'c', 'd', 'e').slice(1, 3) == List('b', 'c')
Inherited from:: IterableOps

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

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters

size: the number of elements per group
step: the distance between the first elements of successive groups

Attributes

Returns: An iterator producing immutable sequences of size size, except the last element (which may be the only element) will be smaller if there are fewer than size elements remaining to be grouped.
See also: scala.collection.Iterator, method sliding
Example: List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))
Inherited from:: IterableOps

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

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters

size: the number of elements per group

Attributes

Returns: An iterator producing immutable sequences of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.
See also: scala.collection.Iterator, method sliding
Example: List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))
Inherited from:: IterableOps

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

Note: will not terminate for infinite-sized collections.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

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

Type parameters

B: the target type of the transformation f, and the type where the ordering ord is defined.

Value parameters

f: the transformation function mapping elements to some other domain B.
ord: the ordering assumed on domain B.

Attributes

Returns

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

See also

scala.math.Ordering

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]]
  val sorted = words.sortBy(x => (x.length, x.head))
  // sorted: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)

Inherited from:

SeqOps

Sorts this immutable sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

The sort is stable. That is, elements that are equal (lt returns false for both directions of comparison) appear in the same order in the sorted sequence as in the original.

Value parameters

lt: a predicate that is true if its first argument strictly precedes its second argument in the desired ordering.

Attributes

Returns

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

Example

  List("Steve", "Bobby", "Tom", "John", "Bob").sortWith((x, y) => x.take(3).compareTo(y.take(3)) < 0)
  // List("Bobby", "Bob", "John", "Steve", "Tom")

Inherited from:

SeqOps

Sorts this immutable sequence according to an Ordering.

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

Type parameters

B: the element type used for ordering (a supertype of A)

Value parameters

ord: the ordering to be used to compare elements.

Attributes

Returns: a immutable sequence consisting of the elements of this immutable sequence sorted according to the ordering ord.
See also: scala.math.Ordering Note: Even when applied to a view or a lazy collection it will always force the elements.
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

Splits this immutable sequence 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.

Value parameters

p: the test predicate

Attributes

Returns: a pair consisting of the longest prefix of this immutable sequence whose elements all satisfy p, and the rest of this immutable sequence.
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Splits this immutable sequence into a prefix/suffix pair at a given position.

Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

Value parameters

n: the position at which to split.

Attributes

Returns: a pair of immutable sequences consisting of the first n elements of this immutable sequence, and the other elements.
Definition Classes: IterableOps -> IterableOnceOps
Inherited from:: IterableOps

Tests whether this immutable 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.

Type parameters

B: the element type used for comparison (a supertype of A)

Value parameters

offset: the index where the sequence is searched.
that: the sequence to test

Attributes

Returns: true if the sequence that is contained in this immutable sequence at index offset, otherwise false.
Inherited from:: SeqOps

Returns a scala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

For collections of Int, Short, Byte or Char, an scala.collection.IntStepper is returned
For collections of Double or Float, a scala.collection.DoubleStepper is returned
For collections of Long a scala.collection.LongStepper is returned
For any other element type, an scala.collection.AnyStepper is returned

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Type parameters

S: the type of the returned Stepper, determined by the implicit StepperShape

Attributes

Inherited from:: IterableOnce

Type parameters

B: Type of elements of the resulting collection (e.g. String)
C2: Type of the resulting collection (e.g. List[String])

Value parameters

b: Builder to use to build the resulting collection
pf: Element transformation partial function

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Type parameters

B: Type of elements of the resulting collections (e.g. Int)
C2: Type of the resulting collection (e.g. List[Int])

Value parameters

b: Builder to use to build the resulting collection
that: Elements to concatenate to this collection

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Type parameters

B: Type of elements of the resulting collection (e.g. String)
C2: Type of the resulting collection (e.g. List[String])

Value parameters

b: Builder to use to build the resulting collection
f: Element transformation function

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Type parameters

B: Type of elements of the resulting collection (e.g. Int)
C2: Type of the resulting collection (e.g. List[Int])

Value parameters

b: Builder to use to build the resulting collection
toIterableOnce: Evidence that A can be seen as an IterableOnce[B]

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Type parameters

B: Type of elements of the resulting collection (e.g. String)
C2: Type of the resulting collection (e.g. List[String])

Value parameters

b: Builder to use to build the resulting collection
f: Element transformation function

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Type parameters

B: Type of elements of the second collection (e.g. String)
C2: Type of the resulting collection (e.g. List[(Int, String)])

Value parameters

b: Builder to use to build the resulting collection
that: Collection to zip with this collection

Attributes

Returns: The resulting collection
Inherited from:: StrictOptimizedIterableOps

Attributes

Inherited from:: Equality

Attributes

Definition Classes: Atom -> Node -> NodeSeq -> Equality
Inherited from:: Atom

Sums the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the result type of the + operator.

Value parameters

num: an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

Attributes

Returns: the sum of all elements of this immutable sequence with respect to the + operator in num.
Inherited from:: IterableOnceOps

The rest of the collection without its first element.

Attributes

Inherited from:: IterableOps

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

Attributes

Returns: an iterator over all the tails of this immutable sequence
Example: List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Inherited from:: IterableOps

Selects the first n elements.

Value parameters

n: the number of elements to take from this immutable sequence.

Attributes

Returns: a immutable sequence consisting only of the first n elements of this immutable sequence, or else the whole immutable sequence, if it has less than n elements. If n is negative, returns an empty immutable sequence.
Inherited from:: IterableOps

A collection containing the last n elements of this collection.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n: the number of elements to take from the end of this collection

Attributes

Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

Takes longest prefix of elements that satisfy a predicate.

Value parameters

p: The predicate used to test elements.

Attributes

Returns: the longest prefix of this immutable sequence whose elements all satisfy the predicate p.
Inherited from:: IterableOps

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U: the return type of f

Value parameters

f: a function to apply to each element in this immutable sequence

Attributes

Returns: The same logical collection as this
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

Returns a text representation of this node. Note that this is not equivalent to the XPath node-test called text(), it is rather an implementation of the XPath function string() Martin to Burak: to do: if you make this method abstract, the compiler will now complain if there's no implementation in a subclass. Is this what we want? Note that this would break doc/DocGenator and doc/ModelToXML, with an error message like:

doc\DocGenerator.scala:1219: error: object creation impossible, since there is a deferred declaration of method text in class Node of type => String which is not implemented in a subclass
new SpecialNode {
^

Attributes

Definition Classes: Atom -> Node -> NodeSeq
Inherited from:: Atom

returns a sequence consisting of only this node

Attributes

Definition Classes: Node -> NodeSeq -> ScalaVersionSpecificNodeSeq
Inherited from:: Node

Given a collection factory factory, converts this immutable sequence to the appropriate representation for the current element type A. Example uses:

import scala.collection.mutable.ArrayBuffer
import scala.collection.immutable.BitSet
val xs: Iterable[Int] = Seq(1, 2, 3, 4, 5)
    xs.to(List)
    xs.to(ArrayBuffer)
    xs.to(BitSet) // for xs: Iterable[Int]

Type parameters

C1: the target collection type

Value parameters

factory: the factory for the target collection type

Attributes

Returns: a new collection of type C1 containing all elements of this immutable sequence
Inherited from:: IterableOnceOps

Converts this immutable sequence to an Array.

Implementation note: DO NOT call Array.from from this method.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This immutable sequence as an Array[B].
Inherited from:: IterableOnceOps

Converts this immutable sequence to a Buffer.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This immutable sequence as a Buffer[B].
Inherited from:: IterableOnceOps

Converts this immutable sequence to an IndexedSeq.

Attributes

Returns: This immutable sequence as an IndexedSeq[A].
Inherited from:: IterableOnceOps

Converts this immutable sequence to a List.

Attributes

Returns: This immutable sequence as a List[A].
Inherited from:: IterableOnceOps

Converts this immutable sequence to a Map, given an implicit coercion from the immutable sequence's type to a key-value tuple.

Type parameters

K: The key type for the resulting map.
V: The value type for the resulting map.

Value parameters

ev: an implicit evidence that A is a subtype of (K, V)

Attributes

Returns: This immutable sequence as a Map[K, V].
Inherited from:: IterableOnceOps

Attributes

Returns: This immutable sequence as a Seq[A]. This is equivalent to to(Seq) but might be faster.
Definition Classes: Seq -> IterableOnceOps
Inherited from:: Seq

Converts this immutable sequence to a Set.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This immutable sequence as a Set[B].
Inherited from:: IterableOnceOps

Same as toString('''false''').

Attributes

Definition Classes: Node -> NodeSeq -> Seq -> Function1 -> Iterable -> Any
Inherited from:: Node

Converts this immutable sequence to a Vector.

Attributes

Returns: This immutable sequence as a Vector[A].
Inherited from:: IterableOnceOps

Transposes this immutable sequence of iterable collections into a immutable sequence of immutable sequences.

The resulting collection's type will be guided by the static type of immutable sequence. 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))

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B: the type of the elements of each iterable collection.

Value parameters

asIterable: an implicit conversion which asserts that the element type of this immutable sequence is an Iterable.

Attributes

Returns: a two-dimensional immutable sequence of immutable sequences which has as nth row the nth column of this immutable sequence.
Throws: IllegalArgumentException
if all collections in this immutable sequence are not of the same size.
Inherited from:: IterableOps

Tries to extract a B from an A in a pattern matching expression.

Attributes

Inherited from:: PartialFunction

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

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

Type parameters

A1: the type of the first half of the element pairs
A2: the type of the second half of the element pairs

Value parameters

asPair: an implicit conversion which asserts that the element type of this immutable sequence is a pair.

Attributes

Returns: a pair of immutable sequences, containing the first, respectively second half of each element pair of this immutable sequence.
Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

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

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

Type parameters

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

Value parameters

asTriple: an implicit conversion which asserts that the element type of this immutable sequence is a triple.

Attributes

Returns: a triple of immutable sequences, containing the first, second, respectively third member of each element triple of this immutable sequence.
Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

A copy of this immutable sequence with one single replaced element.

Type parameters

B: the element type of the returned immutable sequence.

Value parameters

elem: the replacing element
index: the position of the replacement

Attributes

Returns: a new immutable sequence which is a copy of this immutable sequence with the element at position index replaced by elem.
Throws: IndexOutOfBoundsException
if index does not satisfy 0 <= index < length. In case of a lazy collection this exception may be thrown at a later time or not at all (if the end of the collection is never evaluated).
Definition Classes: StrictOptimizedSeqOps -> SeqOps
Inherited from:: StrictOptimizedSeqOps

A view over the elements of this collection.

Attributes

Definition Classes: SeqOps -> IterableOps
Inherited from:: SeqOps

Creates a non-strict filter of this immutable sequence.

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.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable sequence which satisfy the predicate p.
Inherited from:: IterableOps

Returns a type symbol (e.g. DTD, XSD), default '''null'''.

Attributes

Inherited from:: Node

Attributes

Inherited from:: Equality

Attributes

Inherited from:: Equality

Attributes

Inherited from:: NodeSeq

Returns a immutable sequence formed from this immutable sequence 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.

Type parameters

B: the type of the second half of the returned pairs

Value parameters

that: The iterable providing the second half of each result pair

Attributes

Returns: a new immutable sequence containing pairs consisting of corresponding elements of this immutable sequence and that. The length of the returned collection is the minimum of the lengths of this immutable sequence and that.
Definition Classes: StrictOptimizedIterableOps -> IterableOps
Inherited from:: StrictOptimizedIterableOps

Returns a immutable sequence formed from this immutable sequence 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.

Type parameters

A1: the type of the first element in each result pair (supertype of A)
B: the type of the second element in each result pair

Value parameters

that: the iterable providing the second half of each result pair
thatElem: the element to be used to fill up the result if that is shorter than this immutable sequence.
thisElem: the element to be used to fill up the result if this immutable sequence is shorter than that.

Attributes

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

Zips this immutable sequence with its indices.

Attributes

Returns: A new immutable sequence containing pairs consisting of all elements of this immutable sequence paired with their index. Indices start at 0.
Example: List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))
Definition Classes: StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Inherited from:: StrictOptimizedIterableOps

PCData

Attributes

Members list

Value members

Concrete methods

Value parameters

Attributes

Inherited methods

Attributes

Type parameters

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Attributes

Attributes

Attributes

Type parameters

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes