File: CartesianProduct.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (73 lines) | stat: -rw-r--r-- 2,623 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
//

/// A type describing the [Cartesian product](https://en.wikipedia.org/wiki/Cartesian_product)
/// of two collections.
///
/// A Cartesian product of two sets is the ordered set containing each pair of
/// elements in those two sets. For example, if the inputs are `[1, 2, 3]`
/// and `["a", "b", "c"]`, the Cartesian product is the set
/// `[(1, "a"), (1, "b"), (1, "c"), (2, "a"), (2, "b"), ... (3, "c")]`.
///
/// This type is not part of the public interface of the testing library.
///
/// @Comment {
///   - Bug: The testing library should support variadic generics.
///     ([103416861](rdar://103416861))
/// }
struct CartesianProduct<C1, C2>: LazySequenceProtocol where C1: Collection, C2: Collection {
  fileprivate var collection1: C1
  fileprivate var collection2: C2

  // MARK: - Sequence

  typealias Element = (C1.Element, C2.Element)

  func makeIterator() -> some IteratorProtocol<Element> {
    collection1.lazy.flatMap { e1 in
      collection2.lazy.map { e2 in
        (e1, e2)
      }
    }.makeIterator()
  }

  var underestimatedCount: Int {
    let (result, overflowed) = collection1.underestimatedCount
      .multipliedReportingOverflow(by: collection2.underestimatedCount)
    if overflowed {
      return .max
    }
    return result
  }
}

extension CartesianProduct: Sendable where C1: Sendable, C2: Sendable {}

/// Creates the Cartesian product of two collections.
///
/// - Parameters:
///   - collection1: The first collection in the Cartesian product.
///   - collection2: The second collection in the Cartesian product.
///
/// - Returns: A sequence of tuples of type `(C1.Element, C2.Element)` derived
///   from the input collections. The sequence can be iterated multiple times.
///
/// When iterating the resulting sequence, `collection1` is iterated only once,
/// while `collection2` is iterated `collection1.count` times.
///
/// For more information on Cartesian products, see ``CartesianProduct``.
///
/// @Comment {
///   - Bug: The testing library should support variadic generics.
///     ([103416861](rdar://103416861))
/// }
func cartesianProduct<C1, C2>(_ collection1: C1, _ collection2: C2) -> CartesianProduct<C1, C2> where C1: Collection, C2: Collection {
  CartesianProduct(collection1: collection1, collection2: collection2)
}