azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the requirement for 'minus(elements)' to have stable hashCode

Browse Source 
#KT-24536
This commit is contained in:
Ilya Gorbunov
2018-09-25 19:11:34 +03:00
parent 27beadad18
commit d6beddaac5
4 changed files with 44 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-stdlib-gen/src/templates/Generators.kt
+17 -3
View File
@@ -358,13 +358,18 @@ object Generators : TemplateGroupBase() {
}
}
private fun elementsConversionClause(elements: Family) =
"""
The [elements] ${elements.doc.collection} may be converted to a [HashSet] to speed up the operation, thus the elements are required to have
a correct and stable implementation of `hashCode()` that doesn't change between successive invocations.
"""
val f_minus_iterable = fn("minus(elements: Iterable<T>)") {
include(Iterables, Sets, Sequences)
} builder {
operator(true)
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] collection." }
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] collection.\n" }
returns("List<T>")
specialFor(Sets, Sequences) { returns("SELF") }
body {
@@ -425,6 +430,9 @@ object Generators : TemplateGroupBase() {
}
}
doc {
doc + elementsConversionClause(Iterables)
}
}
val f_minus_array = fn("minus(elements: Array<out T>)") {
@@ -432,7 +440,7 @@ object Generators : TemplateGroupBase() {
} builder {
operator(true)
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] array." }
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] array.\n" }
returns("List<T>")
specialFor(Sets, Sequences) { returns("SELF") }
body {
@@ -481,6 +489,9 @@ object Generators : TemplateGroupBase() {
"""
}
}
doc {
doc + elementsConversionClause(ArraysOfObjects)
}
}
val f_minus_sequence = fn("minus(elements: Sequence<T>)") {
@@ -488,7 +499,7 @@ object Generators : TemplateGroupBase() {
} builder {
operator(true)
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] sequence." }
doc { "Returns a list containing all elements of the original collection except the elements contained in the given [elements] sequence.\n" }
returns("List<T>")
specialFor(Sets, Sequences) { returns("SELF") }
body {
@@ -542,6 +553,9 @@ object Generators : TemplateGroupBase() {
"""
}
}
doc {
doc + elementsConversionClause(Sequences)
}
}
val f_partition = fn("partition(predicate: (T) -> Boolean)") {