[DRAFT] Rename PersistentCollection methods to participial forms and deprecate originals

benchmarks/commonMain/src/benchmarks/immutableList/Add.kt

@@ -46,7 +46,7 @@ open class Add {
      */
     @Benchmark
     fun addFirst(): ImmutableList<String> {
-        return persistentListAdd(size - 1).add(0, "another element")
+        return persistentListAdd(size - 1).adding(0, "another element")
     }
 
     /**
@@ -60,6 +60,6 @@ open class Add {
      */
     @Benchmark
     fun addMiddle(): ImmutableList<String> {
-        return persistentListAdd(size - 1).add(size / 2, "another element")
+        return persistentListAdd(size - 1).adding(size / 2, "another element")
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/AddAll.kt

@@ -35,7 +35,7 @@ open class AddAll {
      */
     @Benchmark
     fun addAllLast(): ImmutableList<String> {
-        return persistentListOf<String>().addAll(listToAdd)
+        return persistentListOf<String>().addingAll(listToAdd)
     }
 
     /**
@@ -46,7 +46,7 @@ open class AddAll {
     fun addAllLast_Half(): ImmutableList<String> {
         val initialSize = size / 2
         val subListToAdd = listToAdd.subList(0, size - initialSize) // assuming subList creation is neglectable
-        return persistentListAdd(initialSize).addAll(subListToAdd)
+        return persistentListAdd(initialSize).addingAll(subListToAdd)
     }
 
     /**
@@ -57,7 +57,7 @@ open class AddAll {
     fun addAllLast_OneThird(): ImmutableList<String> {
         val initialSize = size - size / 3
         val subListToAdd = listToAdd.subList(0, size - initialSize)
-        return persistentListAdd(initialSize).addAll(subListToAdd)
+        return persistentListAdd(initialSize).addingAll(subListToAdd)
     }
 
     /**
@@ -68,7 +68,7 @@ open class AddAll {
     fun addAllFirst_Half(): ImmutableList<String> {
         val initialSize = size / 2
         val subListToAdd = listToAdd.subList(0, size - initialSize)
-        return persistentListAdd(initialSize).addAll(0, subListToAdd)
+        return persistentListAdd(initialSize).addingAll(0, subListToAdd)
     }
 
     /**
@@ -79,7 +79,7 @@ open class AddAll {
     fun addAllFirst_OneThird(): ImmutableList<String> {
         val initialSize = size - size / 3
         val subListToAdd = listToAdd.subList(0, size - initialSize)
-        return persistentListAdd(initialSize).addAll(0, subListToAdd)
+        return persistentListAdd(initialSize).addingAll(0, subListToAdd)
     }
 
     /**
@@ -91,7 +91,7 @@ open class AddAll {
         val initialSize = size / 2
         val index = initialSize / 2
         val subListToAdd = listToAdd.subList(0, size - initialSize)
-        return persistentListAdd(initialSize).addAll(index, subListToAdd)
+        return persistentListAdd(initialSize).addingAll(index, subListToAdd)
     }
 
     /**
@@ -103,6 +103,6 @@ open class AddAll {
         val initialSize = size - size / 3
         val index = initialSize / 2
         val subListToAdd = listToAdd.subList(0, size - initialSize)
-        return persistentListAdd(initialSize).addAll(index, subListToAdd)
+        return persistentListAdd(initialSize).addingAll(index, subListToAdd)
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/Remove.kt

@@ -27,7 +27,7 @@ open class Remove {
     fun removeLast(): ImmutableList<String> {
         var list = persistentList
         repeat(times = size) {
-            list = list.removeAt(list.size - 1)
+            list = list.removingAt(list.size - 1)
         }
         return list
     }
@@ -43,7 +43,7 @@ open class Remove {
     @Benchmark
     fun removeFirst(): ImmutableList<String> {
         val list = persistentList
-        return list.removeAt(0)
+        return list.removingAt(0)
     }
 
     /**
@@ -57,6 +57,6 @@ open class Remove {
     @Benchmark
     fun removeMiddle(): ImmutableList<String> {
         val list = persistentList
-        return list.removeAt(size / 2)
+        return list.removingAt(size / 2)
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/RemoveAll.kt

@@ -20,7 +20,7 @@ open class RemoveAll {
 
     @Setup
     fun prepare() {
-        persistentList = persistentListOf<Int>().addAll(List(size) { it })
+        persistentList = persistentListOf<Int>().addingAll(List(size) { it })
     }
 
     // Results of the following benchmarks do not indicate memory or time spent per operation,
@@ -38,7 +38,7 @@ open class RemoveAll {
     fun removeAll_All(): PersistentList<Int> {
         val list = persistentList
         val elementsToRemove = List(size) { it }
-        return list.removeAll(elementsToRemove)
+        return list.removingAll(elementsToRemove)
     }
 
     /**
@@ -48,7 +48,7 @@ open class RemoveAll {
     fun removeAll_RandomHalf(): PersistentList<Int> {
         val list = persistentList
         val elementsToRemove = randomIndexes(size / 2)
-        return list.removeAll(elementsToRemove)
+        return list.removingAll(elementsToRemove)
     }
 
     /**
@@ -58,7 +58,7 @@ open class RemoveAll {
     fun removeAll_RandomTen(): PersistentList<Int> {
         val list = persistentList
         val elementsToRemove = randomIndexes(10)
-        return list.removeAll(elementsToRemove)
+        return list.removingAll(elementsToRemove)
     }
 
     /**
@@ -68,7 +68,7 @@ open class RemoveAll {
     fun removeAll_Tail(): PersistentList<Int> {
         val list = persistentList
         val elementsToRemove = List(tailSize()) { size - 1 - it }
-        return list.removeAll(elementsToRemove)
+        return list.removingAll(elementsToRemove)
     }
 
     /**
@@ -78,7 +78,7 @@ open class RemoveAll {
     fun removeAll_NonExisting(): PersistentList<Int> {
         val list = persistentList
         val elementsToRemove = randomIndexes(10).map { size + it }
-        return list.removeAll(elementsToRemove)
+        return list.removingAll(elementsToRemove)
     }
 
     private fun randomIndexes(count: Int): List<Int> {
@@ -89,4 +89,4 @@ open class RemoveAll {
         val bufferSize = 32
         return (size and (bufferSize - 1)).let { if (it == 0) bufferSize else it }
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/RemoveAllPredicate.kt

@@ -39,7 +39,7 @@ open class RemoveAllPredicate {
         tailElementsPredicate = { it in tailElements }
 
         val allElements = List(size) { it.toString() }
-        persistentList = persistentListOf<String>().addAll(allElements)
+        persistentList = persistentListOf<String>().addingAll(allElements)
     }
 
     // The benchmarks measure (time and memory spent in `removeAll` operation) / size
@@ -50,37 +50,37 @@ open class RemoveAllPredicate {
     /** Removes all elements. */
     @Benchmark
     fun removeAll_All(): PersistentList<String> {
-        return persistentList.removeAll(truePredicate)
+        return persistentList.removingAll(truePredicate)
     }
 
     /** Removes no elements. */
     @Benchmark
     fun removeAll_Non(): PersistentList<String> {
-        return persistentList.removeAll(falsePredicate)
+        return persistentList.removingAll(falsePredicate)
     }
 
     /** Removes half of the elements randomly selected. */
     @Benchmark
     fun removeAll_RandomHalf(): PersistentList<String> {
-        return persistentList.removeAll(randomHalfElementsPredicate)
+        return persistentList.removingAll(randomHalfElementsPredicate)
     }
 
     /** Removes 10 random elements. */
     @Benchmark
     fun removeAll_RandomTen(): PersistentList<String> {
-        return persistentList.removeAll(randomTenElementsPredicate)
+        return persistentList.removingAll(randomTenElementsPredicate)
     }
 
     /** Removes a random element. */
     @Benchmark
     fun removeAll_RandomOne(): PersistentList<String> {
-        return persistentList.removeAll(randomOneElementPredicate)
+        return persistentList.removingAll(randomOneElementPredicate)
     }
 
     /** Removes last [tailSize] elements. */
     @Benchmark
     fun removeAll_Tail(): PersistentList<String> {
-        return persistentList.removeAll(tailElementsPredicate)
+        return persistentList.removingAll(tailElementsPredicate)
     }
 
     private fun randomIndexes(count: Int): List<Int> {

benchmarks/commonMain/src/benchmarks/immutableList/Set.kt

@@ -28,16 +28,16 @@ open class Set {
     @Benchmark
     fun setByIndex(): ImmutableList<String> {
         repeat(times = size) { index ->
-            persistentList = persistentList.set(index, "another element")
+            persistentList = persistentList.replacingAt(index, "another element")
         }
         return persistentList
     }
 
     @Benchmark
     fun setByRandomIndex(): ImmutableList<String> {
         repeat(times = size) { index ->
-            persistentList = persistentList.set(randomIndices[index], "another element")
+            persistentList = persistentList.replacingAt(randomIndices[index], "another element")
         }
         return persistentList
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/builder/RemoveAll.kt

@@ -86,7 +86,7 @@ open class RemoveAll {
         val immutableSize = immutableSize(size, immutablePercentage)
         var list = persistentListOf<Int>()
         for (i in 0 until immutableSize) {
-            list = list.add(i)
+            list = list.adding(i)
         }
         val builder = list.builder()
         for (i in immutableSize until size) {
@@ -103,4 +103,4 @@ open class RemoveAll {
         val bufferSize = 32
         return (size and (bufferSize - 1)).let { if (it == 0) bufferSize else it }
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableList/utils.kt

@@ -11,7 +11,7 @@ import kotlinx.collections.immutable.persistentListOf
 fun persistentListAdd(size: Int): PersistentList<String> {
     var list = persistentListOf<String>()
     repeat(times = size) {
-        list = list.add("some element")
+        list = list.adding("some element")
     }
     return list
-}
+}

benchmarks/commonMain/src/benchmarks/immutableMap/Canonicalization.kt

@@ -68,7 +68,7 @@ open class Canonicalization {
         var map = persistentMapRemove(persistentMap, keysToRemove)
 
         for (key in keysToRemove) {
-            map = map.put(key, "new value")
+            map = map.putting(key, "new value")
         }
 
         return map
@@ -111,7 +111,7 @@ open class Canonicalization {
         var map = halfHeightPersistentMap
 
         repeat(size - halfHeightPersistentMap.size) { index ->
-            map = map.put(keys[index], "new value")
+            map = map.putting(keys[index], "new value")
         }
 
         return map
@@ -137,4 +137,4 @@ open class Canonicalization {
             }
         }
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableMap/Equals.kt

@@ -30,7 +30,7 @@ open class Equals {
         val keys = generateKeys(hashCodeType, size * 2)
         persistentMap = persistentMapPut(implementation, keys.take(size))
         sameMap = persistentMapPut(implementation, keys.take(size))
-        slightlyDifferentMap = sameMap.put(keys[size], "different value").remove(keys[0])
+        slightlyDifferentMap = sameMap.putting(keys[size], "different value").removing(keys[0])
         veryDifferentMap = persistentMapPut(implementation, keys.drop(size))
     }
 
@@ -40,4 +40,4 @@ open class Equals {
     fun nearlyEquals() = persistentMap == slightlyDifferentMap
     @Benchmark
     fun notEquals() = persistentMap == veryDifferentMap
-}
+}

benchmarks/commonMain/src/benchmarks/immutableMap/PutAll.kt

@@ -37,16 +37,16 @@ open class PutAll {
 
     @Benchmark
     fun putAllEqualSize(): PersistentMap<IntWrapper, String> {
-        return lhs.putAll(rhs)
+        return lhs.puttingAll(rhs)
     }
 
     @Benchmark
     fun putAllSmallIntoLarge(): PersistentMap<IntWrapper, String> {
-        return lhs.putAll(rhsSmall)
+        return lhs.puttingAll(rhsSmall)
     }
 
     @Benchmark
     fun putAllLargeIntoSmall(): PersistentMap<IntWrapper, String> {
-        return lhsSmall.putAll(rhs)
+        return lhsSmall.puttingAll(rhs)
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableMap/Remove.kt

@@ -37,8 +37,8 @@ open class Remove {
     fun remove(): PersistentMap<IntWrapper, String> {
         var map = persistentMap
         repeat(times = size) { index ->
-            map = map.remove(keys[index])
+            map = map.removing(keys[index])
         }
         return map
     }
-}
+}

benchmarks/commonMain/src/benchmarks/immutableMap/builder/utils.kt

@@ -19,7 +19,7 @@ fun persistentMapBuilderPut(
 
     var map = emptyPersistentMap<IntWrapper, String>(implementation)
     for (index in 0 until immutableSize) {
-        map = map.put(keys[index], "some value")
+        map = map.putting(keys[index], "some value")
     }
 
     val builder = map.builder()

benchmarks/commonMain/src/benchmarks/immutableMap/utils.kt

@@ -22,15 +22,15 @@ fun <K, V> emptyPersistentMap(implementation: String): PersistentMap<K, V> = whe
 fun <K> persistentMapPut(implementation: String, keys: List<K>): PersistentMap<K, String> {
     var map = emptyPersistentMap<K, String>(implementation)
     for (key in keys) {
-        map = map.put(key, "some value")
+        map = map.putting(key, "some value")
     }
     return map
 }
 
 fun <K> persistentMapRemove(persistentMap: PersistentMap<K, String>, keys: List<K>): PersistentMap<K, String> {
     var map = persistentMap
     for (key in keys) {
-        map = map.remove(key)
+        map = map.removing(key)
     }
     return map
 }

benchmarks/commonMain/src/benchmarks/immutableSet/Canonicalization.kt

@@ -68,7 +68,7 @@ open class Canonicalization {
         var set = persistentSetRemove(persistentSet, elementsToRemove)
 
         for (element in elementsToRemove) {
-            set = set.add(element)
+            set = set.adding(element)
         }
 
         return set
@@ -111,7 +111,7 @@ open class Canonicalization {
         var set = halfHeightPersistentSet
 
         for (element in elementsToRemove) {
-            set = set.add(element)
+            set = set.adding(element)
         }
 
         return set
@@ -137,4 +137,4 @@ open class Canonicalization {
             }
         }
     }
-}
+}