summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/GenTraversableOnce.scala
diff options
context:
space:
mode:
authormichelou <michelou@epfl.ch>2011-07-15 16:25:42 +0000
committermichelou <michelou@epfl.ch>2011-07-15 16:25:42 +0000
commita0476af6bce252a7e724e6e99e50a80f0021ce78 (patch)
tree8d1cc42b8ae676330d776e7b722afa623585818b /src/library/scala/collection/GenTraversableOnce.scala
parentd79493bb728b4d47a1e333a0d8451b8e73c08041 (diff)
downloadscala-a0476af6bce252a7e724e6e99e50a80f0021ce78.tar.gz
scala-a0476af6bce252a7e724e6e99e50a80f0021ce78.tar.bz2
scala-a0476af6bce252a7e724e6e99e50a80f0021ce78.zip
2nd round of clean ups (see r25285)
Diffstat (limited to 'src/library/scala/collection/GenTraversableOnce.scala')
-rw-r--r--src/library/scala/collection/GenTraversableOnce.scala50
1 files changed, 27 insertions, 23 deletions
diff --git a/src/library/scala/collection/GenTraversableOnce.scala b/src/library/scala/collection/GenTraversableOnce.scala
index f27a176c44..67ae044ebf 100644
--- a/src/library/scala/collection/GenTraversableOnce.scala
+++ b/src/library/scala/collection/GenTraversableOnce.scala
@@ -19,10 +19,12 @@ package scala.collection
* @define possiblyparinfo
* This trait may possibly have operations implemented in parallel.
* @define undefinedorder
- * The order in which operations are performed on elements is unspecified and may be nondeterministic.
+ * The order in which operations are performed on elements is unspecified
+ * and may be nondeterministic.
* @define orderDependent
*
- * Note: might return different results for different runs, unless the underlying collection type is ordered.
+ * Note: might return different results for different runs, unless the
+ * underlying collection type is ordered.
* @define orderDependentFold
*
* Note: might return different results for different runs, unless the
@@ -91,7 +93,8 @@ trait GenTraversableOnce[+A] {
*/
def reduce[A1 >: A](op: (A1, A1) => A1): A1
- /** Optionally reduces the elements of this sequence using the specified associative binary operator.
+ /** Optionally reduces the elements of this sequence using the specified
+ * associative binary operator.
*
* $undefinedorder
*
@@ -107,13 +110,14 @@ trait GenTraversableOnce[+A] {
*/
def reduceOption[A1 >: A](op: (A1, A1) => A1): Option[A1]
- /** Folds the elements of this sequence using the specified associative binary operator.
- * The order in which the elements are reduced is unspecified and may be nondeterministic.
+ /** Folds the elements of this sequence using the specified associative
+ * binary operator. The order in which the elements are reduced is
+ * unspecified and may be nondeterministic.
*
* Note this method has a different signature than the `foldLeft`
* and `foldRight` methods of the trait `Traversable`.
- * The result of folding may only be a supertype of this parallel collection's
- * type parameter `T`.
+ * The result of folding may only be a supertype of this parallel
+ * collection's type parameter `T`.
*
* @tparam U a type parameter for the binary operator, a supertype of `T`.
* @param z a neutral element for the fold operation, it may be added to the result
@@ -141,7 +145,7 @@ trait GenTraversableOnce[+A] {
* @return the result of inserting `op` between consecutive elements of this $coll,
* going left to right with the start value `z` on the left:
* {{{
- * op(...op(op(z, x,,1,,), x,,2,,), ..., x,,n,,)
+ * op(...op(op(z, x1), x2), ..., xn)
* }}}
* where `x,,1,,, ..., x,,n,,` are the elements of this $coll.
*/
@@ -161,7 +165,7 @@ trait GenTraversableOnce[+A] {
* @return the result of inserting `op` between consecutive elements of this $coll,
* going right to left with the start value `z` on the right:
* {{{
- * op(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))
+ * op(x1, op(x2, ... op(xn, z)...))
* }}}
* where `x,,1,,, ..., x,,n,,` are the elements of this $coll.
*/
@@ -179,7 +183,7 @@ trait GenTraversableOnce[+A] {
* @return the result of inserting `op` between consecutive elements of this $coll,
* going left to right with the start value `z` on the left:
* {{{
- * op(...op(z, x,,1,,), x,,2,,, ..., x,,n,,)
+ * op(...op(z, x1), x2, ..., xn)
* }}}
* where `x,,1,,, ..., x,,n,,` are the elements of this $coll.
*/
@@ -196,7 +200,7 @@ trait GenTraversableOnce[+A] {
* @return the result of inserting `op` between consecutive elements of this $coll,
* going right to left with the start value `z` on the right:
* {{{
- * op(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))
+ * op(x1, op(x2, ... op(xn, z)...))
* }}}
* where `x,,1,,, ..., x,,n,,` are the elements of this $coll.
*/
@@ -204,18 +208,18 @@ trait GenTraversableOnce[+A] {
/** Aggregates the results of applying an operator to subsequent elements.
*
- * This is a more general form of `fold` and `reduce`. It has similar semantics, but does
- * not require the result to be a supertype of the element type. It traverses the elements in
- * different partitions sequentially, using `seqop` to update the result, and then
- * applies `combop` to results from different partitions. The implementation of this
- * operation may operate on an arbitrary number of collection partitions, so `combop`
- * may be invoked arbitrary number of times.
- *
- * For example, one might want to process some elements and then produce a `Set`. In this
- * case, `seqop` would process an element and append it to the list, while `combop`
- * would concatenate two lists from different partitions together. The initial value
- * `z` would be an empty set.
- *
+ * This is a more general form of `fold` and `reduce`. It has similar
+ * semantics, but does not require the result to be a supertype of the
+ * element type. It traverses the elements in different partitions
+ * sequentially, using `seqop` to update the result, and then applies
+ * `combop` to results from different partitions. The implementation of
+ * this operation may operate on an arbitrary number of collection
+ * partitions, so `combop` may be invoked arbitrary number of times.
+ *
+ * For example, one might want to process some elements and then produce
+ * a `Set`. In this case, `seqop` would process an element and append it
+ * to the list, while `combop` would concatenate two lists from different
+ * partitions together. The initial value `z` would be an empty set.
* {{{
* pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)
* }}}