EnumerateGenerator

The GeneratorType for EnumerateSequence. EnumerateGenerator wraps a Base GeneratorType and yields successive Int values, starting at zero, along with the elements of the underlying Base:

  • var g = EnumerateGenerator(["foo", "bar"].generate())
  • g.next() // (0, "foo")
  • g.next() // (1, "bar")
  • g.next() // nil

Note: Idiomatic usage is to call enumerate instead of constructing an EnumerateGenerator directly.

Inheritance GeneratorType, SequenceType View Protocol Hierarchy →
Associated Types
  • Element = (index: Int, element: Base.Element)

The type of element returned by next().

Type alias inferred.
Import
  • import Swift

Initializers

init(_:)

Construct from a Base generator.

Declaration

  • init(_ base: Base)

Instance Variables

var lazy: LazySequence<EnumerateGenerator<Base>>

A sequence containing the same elements as a Base sequence, but on which some operations such as map and filter are implemented lazily.

See Also: LazySequenceType, LazySequence

Declaration

Declared In

SequenceType

1 inherited item hidden. (Show all)

Instance Methods

func contains(_:)

Return true iff an element in self satisfies predicate.

Declaration

  • func contains(@noescape predicate: ((index: Int, element: Base.Element)) throws -> Bool) rethrows -> Bool

Declared In

SequenceType
func dropFirst()

Returns a subsequence containing all but the first element.

Requires: n >= 0 Complexity: O(n)

Declaration

Declared In

SequenceType
func dropFirst(_:)

Returns a subsequence containing all but the first n elements.

Requires: n >= 0 Complexity: O(n)

Declaration

Declared In

SequenceType
func dropLast()

Returns a subsequence containing all but the last element.

Requires: self is a finite sequence. Requires: n >= 0 Complexity: O(self.count)

Declaration

Declared In

SequenceType
func dropLast(_:)

Returns a subsequence containing all but the last n elements.

Requires: self is a finite collection. Requires: n >= 0 Complexity: O(self.count)

Declaration

Declared In

SequenceType
func elementsEqual(_:isEquivalent:)

Return true iff self and other contain equivalent elements, using isEquivalent as the equivalence test.

Requires: isEquivalent is an equivalence relation.

Declaration

  • func elementsEqual<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) throws -> Bool) rethrows -> Bool

Declared In

SequenceType
func enumerate()

Return a lazy SequenceType containing pairs (n, x), where ns are consecutive Ints starting at zero, and xs are the elements of base:

  • for (n, c) in "Swift".characters.enumerate() {
  •     print("\(n): '\(c)'")
  •   }
  • 0: 'S'
  • 1: 'w'
  • 2: 'i'
  • 3: 'f'
  • 4: 't'

Declaration

Declared In

SequenceType
func filter(_:)

Return an Array containing the elements of self, in order, that satisfy the predicate includeElement.

Declaration

  • func filter(@noescape includeElement: ((index: Int, element: Base.Element)) throws -> Bool) rethrows -> [(index: Int, element: Base.Element)]

Declared In

SequenceType
func flatMap<T>(_: ((index: Int, element: Base.Element)) throws -> T?)

Return an Array containing the non-nil results of mapping transform over self.

Complexity: O(M + N), where M is the length of self and N is the length of the result.

Declaration

  • func flatMap<T>(@noescape transform: ((index: Int, element: Base.Element)) throws -> T?) rethrows -> [T]

Declared In

SequenceType
func flatMap<S : SequenceType>(_: ((index: Int, element: Base.Element)) throws -> S)

Return an Array containing the concatenated results of mapping transform over self.

  • s.flatMap(transform)

is equivalent to

  • Array(s.map(transform).flatten())

Complexity: O(M + N), where M is the length of self and N is the length of the result.

Declaration

  • func flatMap<S : SequenceType>(transform: ((index: Int, element: Base.Element)) throws -> S) rethrows -> [S.Generator.Element]

Declared In

SequenceType
func forEach(_:)

Call body on each element in self in the same order as a for-in loop.

  • sequence.forEach {
  •   // body code
  • }

is similar to:

  • for element in sequence {
  •   // body code
  • }

Note: You cannot use the break or continue statement to exit the current call of the body closure or skip subsequent calls. Note: Using the return statement in the body closure will only exit from the current call to body, not any outer scope, and won't skip subsequent calls.

Complexity: O(self.count)

Declaration

  • func forEach(@noescape body: ((index: Int, element: Base.Element)) throws -> ()) rethrows

Declared In

SequenceType
func lexicographicalCompare(_:isOrderedBefore:)

Return true iff self precedes other in a lexicographical ("dictionary") ordering, using isOrderedBefore as the comparison between elements.

Note: This method implements the mathematical notion of lexicographical ordering, which has no connection to Unicode. If you are sorting strings to present to the end-user, you should use String APIs that perform localized comparison.

Requires: isOrderedBefore is a strict weak ordering over the elements of self and other.

Declaration

  • func lexicographicalCompare<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isOrderedBefore: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) throws -> Bool) rethrows -> Bool

Declared In

SequenceType
func map(_:)

Return an Array containing the results of mapping transform over self.

Complexity: O(N).

Declaration

  • func map<T>(@noescape transform: ((index: Int, element: Base.Element)) throws -> T) rethrows -> [T]

Declared In

SequenceType
func maxElement(_:)

Returns the maximum element in self or nil if the sequence is empty.

Complexity: O(elements.count).

Requires: isOrderedBefore is a strict weak ordering. over self.

Declaration

  • func maxElement(@noescape isOrderedBefore: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) throws -> Bool) rethrows -> (index: Int, element: Base.Element)?

Declared In

SequenceType
func minElement(_:)

Returns the minimum element in self or nil if the sequence is empty.

Complexity: O(elements.count).

Requires: isOrderedBefore is a strict weak ordering. over self.

Declaration

  • func minElement(@noescape isOrderedBefore: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) throws -> Bool) rethrows -> (index: Int, element: Base.Element)?

Declared In

SequenceType
mutating func next()

Advance to the next element and return it, or nil if no next element exists.

Requires: No preceding call to self.next() has returned nil.

Declaration

  • mutating func next() -> (index: Int, element: Base.Element)?
func prefix(_:)

Returns a subsequence, up to maxLength in length, containing the initial elements.

If maxLength exceeds self.count, the result contains all the elements of self.

Requires: maxLength >= 0

Declaration

Declared In

SequenceType
func reduce(_:combine:)

Return the result of repeatedly calling combine with an accumulated value initialized to initial and each element of self, in turn, i.e. return combine(combine(...combine(combine(initial, self[0]), self[1]),...self[count-2]), self[count-1]).

Declaration

  • func reduce<T>(initial: T, @noescape combine: (T, (index: Int, element: Base.Element)) throws -> T) rethrows -> T

Declared In

SequenceType
func reverse()

Return an Array containing the elements of self in reverse order.

Complexity: O(N), where N is the length of self.

Declaration

  • func reverse() -> [(index: Int, element: Base.Element)]

Declared In

SequenceType
func sort(_:)

Return an Array containing the sorted elements of source according to isOrderedBefore.

The sorting algorithm is not stable (can change the relative order of elements for which isOrderedBefore does not establish an order).

Requires: isOrderedBefore is a strict weak ordering over the elements in self.

Declaration

  • func sort(@noescape isOrderedBefore: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) -> Bool) -> [(index: Int, element: Base.Element)]

Declared In

SequenceType
func split(_:allowEmptySlices:isSeparator:)

Returns the maximal SubSequences of self, in order, that don't contain elements satisfying the predicate isSeparator.

maxSplit: The maximum number of SubSequences to return, minus 1. If maxSplit + 1 SubSequences are returned, the last one is a suffix of self containing the remaining elements. The default value is Int.max.

allowEmptySubsequences: If true, an empty SubSequence is produced in the result for each pair of consecutive elements satisfying isSeparator. The default value is false.

Requires: maxSplit >= 0

Declaration

  • func split(maxSplit: Int = default, allowEmptySlices: Bool = default, @noescape isSeparator: ((index: Int, element: Base.Element)) throws -> Bool) rethrows -> [AnySequence<(index: Int, element: Base.Element)>]

Declared In

SequenceType
func startsWith(_:isEquivalent:)

Return true iff self begins with elements equivalent to those of other, using isEquivalent as the equivalence test. Return true if other is empty.

Requires: isEquivalent is an equivalence relation.

Declaration

  • func startsWith<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: ((index: Int, element: Base.Element), (index: Int, element: Base.Element)) throws -> Bool) rethrows -> Bool

Declared In

SequenceType
func suffix(_:)

Returns a slice, up to maxLength in length, containing the final elements of s.

If maxLength exceeds s.count, the result contains all the elements of s.

Requires: self is a finite sequence. Requires: maxLength >= 0

Declaration

Declared In

SequenceType
func underestimateCount()

Return a value less than or equal to the number of elements in self, nondestructively.

Complexity: O(N).

Declaration

  • func underestimateCount() -> Int

Declared In

SequenceType

23 inherited items hidden. (Show all)

Conditionally Inherited Items

The initializers, methods, and properties listed below may be available on this type under certain conditions (such as methods that are available on Array when its elements are Equatable) or may not ever be available if that determination is beyond SwiftDoc.org's capabilities. Please open an issue on GitHub if you see something out of place!

Where Generator == Self, Self : GeneratorType

func generate()

Return a generator over the elements of this sequence.

Complexity: O(1).

Declaration

Declared In

SequenceType

1 inherited item hidden. (Show all)