[SE-0494][StdLib] Add isTriviallyIdentical(to:) Methods to Dictionary and Set

[vanvoorden]

Background

SE-0494

We propose new isTriviallyIdentical(to:) instance methods to the following concrete types for determining in constant-time if two instances must be equal by-value:

• String
• Substring
• Array
• ArraySlice
• ContiguousArray
• Dictionary
• Set

Instead of “one big diff”… we can try and keep the diffs grouped together by similar functionality:

• String, Substring
• Array, ArraySlice, ContiguousArray
• Dictionary, Set

Changes

Our Dictionary does not directly perform a fast path for equality checking in our == operator.¹ We can actually steal an idea from Dictionary.Keys.² If both variants are native, we compare the storage buffer directly. If both variants are Cocoa, we compare the objects directly.

extension Dictionary {
  @_alwaysEmitIntoClient
  public func isIdentical(to other: Self) -> Bool {
#if _runtime(_ObjC)
    if
      self._variant.isNative,
      other._variant.isNative,
      unsafe (self._variant.asNative._storage === other._variant.asNative._storage)
    {
      return true
    }
    if
      !self._variant.isNative,
      !other._variant.isNative,
      self._variant.asCocoa.object === other._variant.asCocoa.object
    {
      return true
    }
#else
    if unsafe (self._variant.asNative._storage === other._variant.asNative._storage) {
      return true
    }
#endif
    return false
  }
}

Our Set performs a similar check over variants for our == operator.³ We can check identity similar to Dictionary:

extension Set {
  @_alwaysEmitIntoClient
  public func isIdentical(to other: Self) -> Bool {
#if _runtime(_ObjC)
    if
      self._variant.isNative,
      other._variant.isNative,
      unsafe (self._variant.asNative._storage === other._variant.asNative._storage)
    {
      return true
    }
    if
      !self._variant.isNative,
      !other._variant.isNative,
      self._variant.asCocoa.object === other._variant.asCocoa.object
    {
      return true
    }
#else
    if unsafe (self._variant.asNative._storage === other._variant.asNative._storage) {
      return true
    }
#endif
    return false
  }
}

Test Plan

New tests were added for Dictionary and Set.

Benchmarks

New benchmarks were added for Dictionary and Set.

Footnotes

1. https://github.com/swiftlang/swift/blob/swift-6.1.2-RELEASE/stdlib/public/core/Dictionary.swift#L1583-L1598 ↩

2. https://github.com/swiftlang/swift/blob/swift-6.1.2-RELEASE/stdlib/public/core/Dictionary.swift#L1365-L1384 ↩

3. https://github.com/swiftlang/swift/blob/swift-6.1.2-RELEASE/stdlib/public/core/Set.swift#L408-L424 ↩

[glessard]

@swift-ci please Apple silicon benchmark

[vanvoorden]

@lorentey Opaque here?

[lorentey]

This type is generic, so sadly the answer is no -- we need this to be at least @inlinable. @_aeic is fine.

[vanvoorden]

@swift-ci please Apple silicon benchmark

[vanvoorden]

@swift-ci Please smoke test

[vanvoorden]

@swift-ci Please smoke test Windows platform

[vanvoorden]

@swift-ci Please smoke test

[vanvoorden]

@swift-ci Please smoke test