[Stdlib] Add notes to lazy collection doc comments about complexity #829
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// - Note: Many lazy collections may not offer the usual performance given by | ||
| /// `CollectionType`, `ForwardIndexType`, or `BidirectionalIndexType`. Be | ||
| /// aware, therefore, that general operations on `LazyCollectionType` | ||
| /// instances may not have the documented complexity. |
There was a problem hiding this comment.
Please remove this note; we have one instance of LazyCollectionType that’s like this, and one other collection that has this behavior and "is lazy” but is-not-a LazyCollectionType, so the note doesn’t belong here.
There was a problem hiding this comment.
Ok. I put it here because I figured any newly-added lazy collections have a decent chance of also having unpredictable performance, but you're right, with only one actual instance of a LazyCollectionType with that performance, it's probably not worth having this note here.
Many lazy collections don't offer O(1) performance for `startIndex`, `first`, or any method that depends on `startIndex`. `LazyFilterCollection` already had a note to this effect (which I tweaked a bit), but `FlattenCollection` didn't. Related to SR-425.
lilyball
force-pushed
the
add-complexity-caveats-to-lazy-collections
branch
from
9edcca0 to
dee1c7a
Compare
|
@dabrahams: Updated as per feedback. |
dabrahams
pushed a commit
that referenced
this pull request
Dec 31, 2015
…collections [Stdlib] Add notes to lazy collection doc comments about complexity
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many lazy collections don't offer O(1) performance for
startIndex,first, or any method that depends onstartIndex.LazyFilterCollectionalready had a note to this effect (which Itweaked a bit), but
FlattenCollectiondidn't, and I added one toLazyCollectionTypefor good measure.Related to SR-425.