mirror of
https://github.com/apple/swift-algorithms
synced 2026-11-22 04:10:39 +00:00
* Add conditional LazySequenceProtocol conformance where appropriate * Add laziness tests * Mention conditional conformance to LazySequenceProtocol in the guides
108 lines
3.3 KiB
Swift
108 lines
3.3 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift Algorithms open source project
|
|
//
|
|
// Copyright (c) 2020 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// A collection wrapper that repeats the elements of a base collection.
|
|
public struct Cycle<Base: Collection> {
|
|
/// The collection to repeat.
|
|
public let base: Base
|
|
}
|
|
|
|
extension Cycle: Sequence {
|
|
/// The iterator for a `Cycle` sequence.
|
|
public struct Iterator: IteratorProtocol {
|
|
@usableFromInline
|
|
let base: Base
|
|
|
|
@usableFromInline
|
|
var current: Base.Index
|
|
|
|
@usableFromInline
|
|
internal init(base: Base) {
|
|
self.base = base
|
|
self.current = base.startIndex
|
|
}
|
|
|
|
@inlinable
|
|
public mutating func next() -> Base.Element? {
|
|
guard !base.isEmpty else { return nil }
|
|
|
|
if current == base.endIndex {
|
|
current = base.startIndex
|
|
}
|
|
|
|
defer { base.formIndex(after: ¤t) }
|
|
return base[current]
|
|
}
|
|
}
|
|
|
|
public func makeIterator() -> Iterator {
|
|
Iterator(base: base)
|
|
}
|
|
}
|
|
|
|
extension Cycle: LazySequenceProtocol where Base: LazySequenceProtocol {}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// cycled()
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
extension Collection {
|
|
/// Returns a sequence that repeats the elements of this collection forever.
|
|
///
|
|
/// Use the `cycled()` method to repeat the elements of a sequence or
|
|
/// collection forever. You can combine `cycled()` with another, finite
|
|
/// sequence to iterate over the two together.
|
|
///
|
|
/// for (evenOrOdd, number) in zip(["even", "odd"].cycled(), 0..<10) {
|
|
/// print("\(number) is \(evenOrOdd)")
|
|
/// }
|
|
/// // 0 is even
|
|
/// // 1 is odd
|
|
/// // 2 is even
|
|
/// // 3 is odd
|
|
/// // ...
|
|
/// // 9 is odd
|
|
///
|
|
/// - Important: When called on a non-empty collection, the resulting sequence
|
|
/// is infinite. Do not directly call methods that require a finite
|
|
/// sequence, like `map` or `filter`, without first constraining the length
|
|
/// of the cycling sequence.
|
|
///
|
|
/// - Returns: A sequence that repeats the elements of this collection
|
|
/// forever.
|
|
///
|
|
/// - Complexity: O(1)
|
|
public func cycled() -> Cycle<Self> {
|
|
Cycle(base: self)
|
|
}
|
|
|
|
/// Returns a sequence that repeats the elements of this collection the
|
|
/// specified number of times.
|
|
///
|
|
/// Passing `1` as `times` results in this collection's elements being
|
|
/// provided a single time; passing `0` results in an empty sequence. The
|
|
/// `print(_:)` function in this example is never called:
|
|
///
|
|
/// for x in [1, 2, 3].cycled(times: 0) {
|
|
/// print(x)
|
|
/// }
|
|
///
|
|
/// - Parameter times: The number of times to repeat this sequence. `times`
|
|
/// must be zero or greater.
|
|
/// - Returns: A sequence that repeats the elements of this sequence `times`
|
|
/// times.
|
|
///
|
|
/// - Complexity: O(1)
|
|
public func cycled(times: Int) -> FlattenSequence<Repeated<Self>> {
|
|
repeatElement(self, count: times).joined()
|
|
}
|
|
}
|