Generic Structure

Entity.ChildCollection.IndexingIterator

No overview available.

Declaration

struct IndexingIterator<Elements> where Elements : Collection

Topics

Iterating over the Collection

func enumerated() -> EnumeratedSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.

func forEach((Elements.Element) -> Void)

Calls the given closure on each element in the sequence in the same order as a for-in loop.

func makeIterator() -> Entity.ChildCollection.IndexingIterator<Elements>

Returns an iterator over the elements of this sequence.

var underestimatedCount: Int

A value less than or equal to the number of elements in the sequence, calculated nondestructively.

Finding Entities

func contains(Elements.Element) -> Bool

Returns a Boolean value indicating whether the sequence contains the given element.

func contains(where: (Elements.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

func allSatisfy((Elements.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.

func first(where: (Elements.Element) -> Bool) -> Elements.Element?

Returns the first element of the sequence that satisfies the given predicate.

func max() -> Elements.Element?

Returns the maximum element in the sequence.

func max(by: (Elements.Element, Elements.Element) -> Bool) -> Elements.Element?

Returns the maximum element in the sequence, using the given predicate as the comparison between elements.

func min() -> Elements.Element?

Returns the minimum element in the sequence.

func min(by: (Elements.Element, Elements.Element) -> Bool) -> Elements.Element?

Returns the minimum element in the sequence, using the given predicate as the comparison between elements.

Selecting Entities

func filter((Elements.Element) -> Bool) -> [Elements.Element]

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

func prefix(Int) -> PrefixSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns a sequence, up to the specified maximum length, containing the initial elements of the sequence.

func prefix(while: (Elements.Element) -> Bool) -> [Elements.Element]

Returns a sequence containing the initial, consecutive elements that satisfy the given predicate.

func suffix(Int) -> [Elements.Element]

Returns a subsequence, up to the given maximum length, containing the final elements of the sequence.

Transforming Entities

func map<T>((Elements.Element) -> T) -> [T]

Returns an array containing the results of mapping the given closure over the sequence’s elements.

func flatMap<SegmentOfResult>((Elements.Element) -> SegmentOfResult) -> [SegmentOfResult.Element]

Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.

func compactMap<ElementOfResult>((Elements.Element) -> ElementOfResult?) -> [ElementOfResult]

Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.

func reduce<Result>(Result, (Result, Elements.Element) -> Result) -> Result

Returns the result of combining the elements of the sequence using the given closure.

func reduce<Result>(into: Result, (inout Result, Elements.Element) -> ()) -> Result

Returns the result of combining the elements of the sequence using the given closure.

var lazy: LazySequence<Entity.ChildCollection.IndexingIterator<Elements>>

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

Reordering Entities

func sorted() -> [Elements.Element]

Returns the elements of the sequence, sorted.

func sorted(by: (Elements.Element, Elements.Element) -> Bool) -> [Elements.Element]

Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.

func reversed() -> [Elements.Element]

Returns an array containing the elements of this sequence in reverse order.

func shuffled() -> [Elements.Element]

Returns the elements of the sequence, shuffled.

func shuffled<T>(using: inout T) -> [Elements.Element]

Returns the elements of the sequence, shuffled using the given generator as a source for randomness.

Splitting and Joining Entities

func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Elements.Element) -> Bool) -> [ArraySlice<Elements.Element>]

Returns the longest possible subsequences of the sequence, in order, that don’t contain elements satisfying the given predicate. Elements that are used to split the sequence are not returned as part of any subsequence.

func split(separator: Elements.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [ArraySlice<Elements.Element>]

Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.

func joined() -> FlattenSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns the elements of this sequence of sequences, concatenated.

func joined<Separator>(separator: Separator) -> JoinedSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.

func joined(separator: String) -> String

Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.

Comparing Collections

func elementsEqual<OtherSequence>(OtherSequence) -> Bool

Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.

func elementsEqual<OtherSequence>(OtherSequence, by: (Elements.Element, OtherSequence.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.

func starts<PossiblePrefix>(with: PossiblePrefix) -> Bool

Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.

func starts<PossiblePrefix>(with: PossiblePrefix, by: (Elements.Element, PossiblePrefix.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.

func lexicographicallyPrecedes<OtherSequence>(OtherSequence) -> Bool

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.

func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (Elements.Element, Elements.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.

Excluding Entities

func dropFirst(Int) -> DropFirstSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns a sequence containing all but the given number of initial elements.

func dropLast(Int) -> [Elements.Element]

Returns a sequence containing all but the given number of final elements.

func drop(while: (Elements.Element) -> Bool) -> DropWhileSequence<Entity.ChildCollection.IndexingIterator<Elements>>

Returns a sequence by skipping the initial, consecutive elements that satisfy the given predicate.

Accessing Underlying Storage

func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Elements.Element>) -> R) -> R?

Call body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.

Working with Rectangles

func clip()
func fill(using: NSCompositingOperation)
func fill(using: NSCompositingOperation)
func fill(using: NSCompositingOperation)

Relationships

See Also

Iterating over Collection of Entities

func forEach((Entity) -> Void)

Calls the given closure on each element in the sequence in the same order as a for-in loop.

func enumerated() -> EnumeratedSequence<Entity.ChildCollection>

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.

var underestimatedCount: Int

A value less than or equal to the number of elements in the collection.