Swift Collections

Swift Collections is an open-source package of data structure implementations for the Swift programming language.

Table of Contents

• Stable Data Structures
  • BasicContainers module
  • DequeModule module
  • OrderedCollections module
  • BitCollections module
  • HeapModule module
  • HashTreeCollections module
  • TrailingElementsModule module
  • ContainersPreview module
  • Collections module
• Experimental Features
  • UnstableContainersPreview package trait
  • UnstableHashedContainers package trait
  • UnstableSortedCollections package trait
• Project Status
  • Definition of Public API
  • Minimum Required Swift Toolchain Version
• Using Swift Collections in your project
• Contributing to Swift Collections
  • Branching Strategy
  • Working on the package
    • Fixing a bug or making a small improvement
    • Proposing a small enhancement
    • Proposing the addition of a new data structure
• Code of Conduct
• Contact information

Stable Data Structures

The package currently provides the following types, organized into thematic modules:

BasicContainers module

Ownership-aware reimplementations of the standard generic collection types Array, Set, and Dictionary.

• struct UniqueArray<Element> is a uniquely held, dynamically resizing array.
• struct RigidArray<Element> is a fixed-capacity array.

DequeModule module

Implementations of double-ended queue types, implemented by a ring buffer.

• struct Deque<Element> is a classic collection, implementing value semantics with the copy-on-write optimization.
• struct UniqueDeque<Element> is a uniquely held, dynamically resizing, noncopyable deque.
• struct RigidDeque<Element> is a fixed-capacity deque implementation.

OrderedCollections module

Provides variants of the standard Set and Dictionary types with user-defined ordering.

• struct OrderedSet<Element> is a Set that preserves insertion order.
• struct OrderedDictionary<Key, Value> is a Dictionary that preserves insertion order.

BitCollections module

Provides efficient implementations of bit maps.

• struct BitSet is a more efficient implementation of Set<Int>.
• struct BitArray is a more efficient implementation of Array<Bool>.

HeapModule module

• struct Heap<Element>, a min-max heap backed by an array, suitable for use as a priority queue.

HashTreeCollections module

Persistent hashed collections implementing Compressed Hash-Array Mapped Prefix Trees (CHAMP). These are like Set and Dictionary, but they support efficient mutations of shared copies of values, without duplicating the unchanged parts.

• struct TreeSet<Element> is a persistent hashed set.
• struct TreeDictionary<Key, Value> is a persistent hashed dictionary.

This is the beginning of the README. Read the rest at the original. Read the full README ↗