Swift Collection underestimateCount 使用情况

Question

我想知道，Collection underestimateCount 的用例是什么？ Documentation 表示它与标准 Collection count 具有相同的复杂性。

/// Returns a value less than or equal to the number of elements in
/// `self`, *nondestructively*.
///
/// - Complexity: O(N).
public func underestimateCount() -> Int

但它没有说明应该在什么时候使用以及出于什么原因。

Answer 1

underestimatedCount 实际上是Sequence 协议的要求，并且有a default implementation 只返回0：

public var underestimatedCount: Int {
  return 0
}

但是，对于提供自己的underestimatedCount 实现的序列，这对于需要序列长度下限的逻辑很有用，而不必遍历它（请记住，Sequence 不保证非破坏性迭代）。

例如，Sequence (see its implementation here) 上的 map(_:) 方法使用 underestimateCount 来为结果数组保留初始容量：

  public func map<T>(
    _ transform: (Iterator.Element) throws -> T
  ) rethrows -> [T] {

    let initialCapacity = underestimatedCount
    var result = ContiguousArray<T>()
    result.reserveCapacity(initialCapacity) 

    // ...

这允许map(_:) 最小化重复附加到result 的成本，因为（可能）已经为其分配了初始内存块（尽管在任何情况下都值得注意ContiguousArray 有一个分摊附加成本的指数增长策略）。

但是，对于Collection，underestimateCount 的the default implementation 实际上只返回集合的count：

public var underestimatedCount: Int {
    // TODO: swift-3-indexing-model - review the following
  return numericCast(count)
}

对于符合 RandomAccessCollection 的集合，这将是 O(1) 操作，否则为 O(n)。

因此，由于这种默认实现，直接使用Collection 的underestimatedCount 肯定不如使用Sequence 的常见，因为Collection 保证了无损迭代，并且在大多数情况下@ 987654346@ 只会返回count。

当然，自定义集合类型可以提供它们自己的underestimatedCount 实现——给出它们包含多少元素的下限，以一种可能比count 实现更有效的方式，这可能很有用.

Answer 2

（因为我建议的重复目标有些过时）

在 Swift 3 中，方法 underestimateCount() 已被计算属性 underestimatedCount 取代。我们可以看看implementation of the latter for Collection的源码：

  /// A value less than or equal to the number of elements in the collection.
  ///
  /// - Complexity: O(1) if the collection conforms to
  ///   `RandomAccessCollection`; otherwise, O(*n*), where *n* is the length
  ///   of the collection.
  public var underestimatedCount: Int {
    // TODO: swift-3-indexing-model - review the following
    return numericCast(count)
  }

  /// The number of elements in the collection.
  ///
  /// - Complexity: O(1) if the collection conforms to
  ///   `RandomAccessCollection`; otherwise, O(*n*), where *n* is the length
  ///   of the collection.
  public var count: IndexDistance {
    return distance(from: startIndex, to: endIndex)
  }

很明显underestimatedCount 只是将count 用于符合Collection 的类型（除非这些类型实现了它们自己的underestimatedCount 版本）。