summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/LinearSeq.scala
diff options
context:
space:
mode:
authorRex Kerr <ichoran@gmail.com>2014-11-23 13:30:03 -0800
committerRex Kerr <ichoran@gmail.com>2014-11-26 13:00:22 -0800
commit6553ccc58ee2ca87249ca0b62ef8aea9ed8952f2 (patch)
tree76eb811fac15129f581743a012a73fa4ca69c340 /src/library/scala/collection/LinearSeq.scala
parentc4df20d29a8d15ef23cf0d10fad56da0791bbbf6 (diff)
downloadscala-6553ccc58ee2ca87249ca0b62ef8aea9ed8952f2.tar.gz
scala-6553ccc58ee2ca87249ca0b62ef8aea9ed8952f2.tar.bz2
scala-6553ccc58ee2ca87249ca0b62ef8aea9ed8952f2.zip
SI-8754 linear seqs aren't
LinearSeqLike still isn't exactly linear (LinearSeqOptimized is), but at least the docs now give reasonably correct information about what is actually going on.
Diffstat (limited to 'src/library/scala/collection/LinearSeq.scala')
-rw-r--r--src/library/scala/collection/LinearSeq.scala7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/library/scala/collection/LinearSeq.scala b/src/library/scala/collection/LinearSeq.scala
index 49fbb902ab..5a7bb5891e 100644
--- a/src/library/scala/collection/LinearSeq.scala
+++ b/src/library/scala/collection/LinearSeq.scala
@@ -15,7 +15,14 @@ import generic._
import mutable.Builder
/** A base trait for linear sequences.
+ *
* $linearSeqInfo
+ *
+ * @define linearSeqInfo
+ * Linear sequences have reasonably efficient `head`, `tail`, and `isEmpty` methods.
+ * If these methods provide the fastest way to traverse the collection, a
+ * collection `Coll` that extends this trait should also extend
+ * `LinearSeqOptimized[A, Coll[A]]`.
*/
trait LinearSeq[+A] extends Seq[A]
with GenericTraversableTemplate[A, LinearSeq]