Swift Collections 1.1.0

This feature release adds a number of new data structure implementations, along with minor changes to existing constructs.

New Data Structures

• Heap implements a min-max heap, backed by a native array. (Contributed by @AquaGeek)
• BitSet and BitArray are two alternate representations of a bitmap type, backed by dynamically allocated storage. (Contributed by @MahanazAtiqullah)
• TreeSet and TreeDictionary are hashed collections implementing Compressed Hash-Array Mapped Prefix Trees (CHAMP). They provide similar API as Set/Dictionary in the Standard Library, but as persistent data structures, supporting incremental mutations of shared instances and efficient structural diffing. (Contributed by @msteindorfer)

Other Changes

• This version of the package can only be built using Swift 5.7.2 or later.
• New methods: the OrderedSet.isEqualSet family of functions provide a way to test that two containers contain the same members, ignoring the order of elements. (#183, #234)
• New method: OrderedSet.filter implements a version of the standard filter operation that returns an OrderedSet instead of an Array. (#159)
• debugDescription implementations have been updated to follow Swift best practice. (These are called by container types like Array to print their elements, so they work best when they're succinct variants of description that are suitable for embedding in structured output: specifically, they must not produce unpaired delimiter characters ([/], (/), {/}, </> etc), raw top level commas, semicolons, colons, unquoted strings etc. debugDescription should not needlessly print type names etc.)

New Contributors

• @AquaGeek made their first contribution in #61
• @ejmarchant made their first contribution in #82
• @just-gull made their first contribution in #115
• @jPaolantonio made their first contribution in #121
• @MahanazAtiqullah made their first contribution in #83
• @hectormatos2011 made their first contribution in #155
• @ktoso made their first contribution in #159
• @CTMacUser made their first contribution in #116
• @hassila made their first contribution in #297

Many thanks to our contributors for their great work (and patience)!

List of Pull Requests

Full Changelog: 1.0.6...1.1.0

• Add a min-max heap implementation that can be used to back a priority queue by @AquaGeek in #61
• [benchmark] Review and extend Heap benchmarks by @lorentey in #76
• Add reference benchmarks for bit vector implementations by @lorentey in #79
• Fix Markdown link in README by @AquaGeek in #77
• Fix documentation for types conforming to ExpressibleByArrayLiteral o… by @ejmarchant in #82
• [Heap] Performance tweaks by @lorentey in #78
• Fix typos: missing subscript parameters by @ejmarchant in #81
• [Heap] Update implementation details section in docs by @lorentey in #84
• Update CMakeLists.txt by @compnerd in #85
• Stop depending on swift-collections-benchmark by @lorentey in #86
• [OrderedDictionary] modifyValue → updateValue by @lorentey in #91
• Add Benchmarks package to workspace by @lorentey in #93
• [OrderedDictionary] Deprecate subscript(offset:) for now by @lorentey in #92
• Documentation: Remove in-place mutation comments by @ejmarchant in #96
• [main] Freeze some types for consistency with their inlinable initializers by @lorentey in #98
• Follow stdlib's leading underscore rule by @ejmarchant in #95
• [Heap] Disable heap tests in release builds by @lorentey in #100
• [NFC] Merge release/1.0 to main by @lorentey in #105
• Merge release/1.0 into main by @lorentey in #108
• [README] Note that Heap hasn't been tagged yet & list other enhancements in progress by @lorentey in #109
• PriorityQueueModule: remove import Foundation by @compnerd in #118
• [Heap] Remove Heap's ascending and descending views by @lorentey in #119
• [Heap] Enable heap tests in optimized builds (#101) by @just-gull in #115
• Update CMakeLists.txt by @compnerd in #122
• Fix link to package internal documentation by @jPaolantonio in #121
• Merge release/1.0 to main by @lorentey in #130
• BitArray and BitSet data structures by @MahanazAtiqullah in #83
• Sorted collections by @vihanb in #65
• Merge release/1.0 to main by @lorentey in #141
• Remove Swift PM Artifacts to avoid Generated Schemes in Xcode by @hectormatos2011 in #155
• Reinstate custom schemes under Utils/swift-collections.xcworkspace by @lorentey in #156
• +OrderedSet add filter #158 by @ktoso in #159
• [Xcode] Update schemes & file template by @lorentey in #161
• [OrderedCollection] Use standard temp allocation facility, if available by @lorentey in #160
• [OrderedSet] Work around weird name lookup issue in compiler by @lorentey in #162
• =OrderedSet.filter Attempt to optimize filter impl by @ktoso in #163
• Force-inline _modify accessors to work around a performance issue by @lorentey in #165
• Merge release/1.0 branch to main by @lorentey in #172
• Incubate persistent data structures by @msteindorfer in #31
• Persistent collections updates by @lorentey in #174
• Persistent collections updates by @lorentey in #175
• Persistent collections updates (part 3) by @lorentey in #176
• Persistent collections updates (part 4) by @lorentey in #177
• [OrderedDictionary] Tiny documentation fix by @lorentey in #178
• Persistent collections updates (part 5) by @lorentey in #179
• Integrate PriorityQueueModule, BitCollections, PersistentCollections, SortedCollections into release/1.1 by @lorentey in #181
• Persistent collections updates (part 6) by @lorentey in #180
• Persistent collections updates (part 7) by @lorentey in #182
• [BitSet] Fix decoding format on 32 bit architectures by @lorentey in #185
• Persistent collections updates (part 8) by @lorentey in #184
• Persistent collections updates (part 9) by @lorentey in #188
• Add Sendable conformances to all public types by @lorentey in #191
• [test] Check baseline API expectations for set-like types by @lorentey in #192
• Fleshing out PersistentSet by @lorentey in #193
• Rename PriorityQueueModule to HeapModule by @lorentey in #194
• [BitSet] Fix invariant violation in member subscript by @lorentey in #195
• [1.1.0] Bump minimum required Swift toolchain to 5.5 by @lorentey in #196
• Restore support for building with Swift 5.5 by @lorentey in #198
• Merge release/1.0 to release/1.1 by @lorentey in #199
• Update CMake configuration in preparation for 1.1 by @lorentey in #200
• Update CMakeLists.txt by @compnerd in #202
• [1.1][SortedCollections] Remove for now by @lorentey in #205
• [Heap] Change value of minimum or maximum element by @CTMacUser in #116
• [Heap] Prerelease preparations by @lorentey in #210
• Update README files by @lorentey in #212
• [manifest] Exclude CMakeLists.txt; remove unnecessary path settings; reindent file by @lorentey in #213
• Review and finalize (?) set relation predicates for 1.1 by @lorentey in #216
• Merge.1.0→1.1 by @lorentey in #217
• Update CMake configuration by @lorentey in #218
• Cherry pick changes from main to release/1.1 by @lorentey in #219
• Fix unusual build problems by @lorentey in #221
• Review & update descriptions throughout the package by @lorentey in #222
• Review and finalize (?) binary set operations for 1.1 by @lorentey in #223
• [Xcode] Disable implicit dependencies by @lorentey in #227
• [OrderedSet] Improve sequence-taking initializer by @lorentey in #226
• [OrderedSet, BitSet] Fix custom mirror display style by @lorentey in #225
• Finalize persistent collections API by @lorentey in #224
• Start working on DocC support by @lorentey in #228
• Update CMake build configuration by @lorentey in #230
• [PersistentSet] Iterator.next(): Make inlinable by @lorentey in #233
• [SetAlgebra types] isEqual(to:) → isEqualSet(to:) by @lorentey in #234
• [PersistentCollections] Doc & benchmark updates in preparation of API review by @lorentey in #235
• Apply changes from in-progress review thread by @lorentey in #237
• [ShareableHashedCollections] API Review: add missing mutating keywords by @lorentey in #238
• [Benchmarks] Split default huge library up into individual files, one per type by @lorentey in #240
• [ShareableHashedCollections] Add missing import by @lorentey in #243
• Unify unsafe bit set implementations by @lorentey in #244
• Fix warnings in development versions of Swift by @lorentey in #245
• [HashTreeCollections] Change prefix Shareable to Tree by @lorentey in #242
• [TreeDictionary] Fix in-place merge operation to properly update the count by @lorentey in #247
• [cmake] Update CMake configuration by @lorentey in #249
• Add not so experimental rope implementation by @lorentey in #264
• Fix off by one error in BitSet by @lorentey in #267
• Monomodule support by @lorentey in #266
• Expose a handful of BigString.Index methods by @lorentey in #269
• BitArray API refinements & additions by @lorentey in #263
• Make most of Rope inlinable by @lorentey in #270
• BigString: Fix String.Index._knownScalarAligned by @lorentey in #272
• Rope: Fix Sendable conformance by @lorentey in #271
• Require Swift 5.6 by @lorentey in #273
• [OrderedDictionary] Explicitly mention in documentation that keys/values are ordered by @lorentey in #275
• [HashCollections] Ensure self doesn’t get destroyed before we’re done working with it by @lorentey in #276
• Remove obsolete swift(>=5.5)/swift(>=5.6) checks by @lorentey in #277
• [Xcode] Update Xcode project by @lorentey in #278
• Minor rope updates by @lorentey in #279
• [Rope] remove(at:): Fix assertion when removing the last item creates a deficiency by @lorentey in #280
• Merge changes from release 1.0 to release 1.1 by @lorentey in #283
• [CollectionUtilities] Silence a warning on 32 bit platforms by @lorentey in #286
• [BitSet] Fix a thinko in BitSet.isEqualSet by @lorentey in #287
• Grab bag of fixes for small test issues by @lorentey in #288
• [Xcode] Set a code sign identity in the Xcode project by @lorentey in #285
• Rope: Fix trap when replaceSubrange is called on an empty rope by @lorentey in #290
• Rope.find returns a bogus remainder for the end position by @lorentey in #291
• Update TreeSet.md by @hassila in #297
• Fix CustomStringConvertible/CustomDebugStringConvertible conformances by @lorentey in #302
• [RopeModule] Fix issues in Swift's ABI stable dialect by @lorentey in #318
• [CMake, Xcode] Update configurations for alternate build systems by @lorentey in #319
• [RopeModule] Remove unnecessary typealiases by @lorentey in #320
• [Heap] Improve type-level doc comment by @lorentey in #326
• [Heap] insert(contentsOf:) Switch to Floyd’s if we’re inserting too many items by @lorentey in #327
• [1.1] build: support building in Debug mode on Windows by @compnerd in #336
• Merge release/1.0 to release/1.1 by @lorentey in #348
• [Heap] Convert min() and max() to properties by @lorentey in #328
• [BitArray] Disable bitwise operators for now by @lorentey in #353
• [Heap] Final(?) Heap API adjustments for 1.1 by @lorentey in #354
• [Benchmarks] Add Collection Equality Benchmarks by @vanvoorden in #351
• Release preparations for 1.1 by @lorentey in #355
• [1.1] Fix typos by @lorentey in #357
• [TreeDictionary][Keys] Add Equatable and Hashable Conformance to TreeDictionary.Keys by @vanvoorden in #352