Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(427)

Unified Diff: sdk/lib/collection/hash_set.dart

Issue 2567393002: Improve document for HashSet. (Closed)
Patch Set: Address comments. Created 4 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/collection/hash_set.dart
diff --git a/sdk/lib/collection/hash_set.dart b/sdk/lib/collection/hash_set.dart
index 89558f827a43824870273f91c9ffaefd09ac0a1c..8bffb3415df823f4fef2cb0a8ebfb78766a5cb6d 100644
--- a/sdk/lib/collection/hash_set.dart
+++ b/sdk/lib/collection/hash_set.dart
@@ -45,9 +45,14 @@ abstract class _HashSetBase<E> extends SetBase<E> {
*
* The set allows `null` as an element.
*
- * Most simple operations on `HashSet` are done in (potentially amorteized)
+ * Most simple operations on `HashSet` are done in (potentially amortized)
* constant time: [add], [contains], [remove], and [length], provided the hash
* codes of objects are well distributed.
+ *
+ * The iteration order of the set is not specified and depends on
+ * the hashcodes of the provided elements. However, the order is stable:
+ * multiple iterations over the same set produce the same order, as long as
+ * the set is not modified.
*/
abstract class HashSet<E> implements Set<E> {
/**
@@ -108,8 +113,10 @@ abstract class HashSet<E> implements Set<E> {
/**
* Create a hash set containing all [elements].
*
- * Creates a hash set as by `new HashSet<E>()` and adds each element of
- * `elements` to this set in the order they are iterated.
+ * Creates a hash set as by `new HashSet<E>()` and adds all given [elements]
+ * to the set. The elements are added in order. If [elements] contains
+ * two entries that are equal, but not identical, then the first one is
+ * the one in the resulting set.
*
* All the [elements] should be assignable to [E].
* The `elements` iterable itself may have any element type, so this
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698