diff options
Diffstat (limited to 'src/library/scala/Stream.scala')
| -rw-r--r-- | src/library/scala/Stream.scala | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/library/scala/Stream.scala b/src/library/scala/Stream.scala index 541ffd833d..6765ec1db8 100644 --- a/src/library/scala/Stream.scala +++ b/src/library/scala/Stream.scala @@ -243,10 +243,16 @@ abstract class Stream[+A] extends Seq.Projection[A] { len } - /** Returns - * - (length - l) if l >= length - * - 1 otherwise - * This method does not call Stream.length. + /** Result of comparing <code>length</code> with operand <code>l</code>. + * returns <code>x</code> where + * <code>x < 0</code> iff <code>this.length < l</code> + * <code>x == 0</code> iff <code>this.length == l</code> + * <code>x > 0</code> iff <code>this.length > that</code>. + * + * This method is used by matching streams against right-ignoring (...,_*) patterns. + * + * This method does not call <code>Stream.length</code>, it works for <code>O(l)</code>, + * not for <code>O(length)</code> and does not force full Stream evaluation. */ final override def lengthCompare(l: Int) = { if (isEmpty) 0 - l |