Structure

IndexPath

IndexPath represents the path to a specific node in a tree of nested array collections.

Overview

Each index in an index path represents the index into an array of children from one node in the tree to another, deeper, node.

Symbols

Initializers

init()

Initialize an empty index path.

init(arrayLiteral: IndexPath.Element...)

Initialize with an array literal.

init(index: IndexPath.Element)

Initialize with a single element.

init(indexes: Array<IndexPath.Element>)

Initialize with an array of elements.

init<ElementSequence>(indexes: ElementSequence)

Initialize with a sequence of integers.

init(item: Int, section: Int)init(item: Int, section: Int)init(row: Int, section: Int)

Instance Properties

var count: Int
var count: Int

The number of elements in the collection.

var customMirror: Mirrorvar debugDescription: Stringvar description: Stringvar endIndex: IndexPath.Index
var first: IndexPath.Element?

The first element of the collection.

var hashValue: Int
var indices: DefaultRandomAccessIndices<IndexPath>

The indices that are valid for subscripting the collection, in ascending order.

var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

var item: Intvar item: Int
var last: IndexPath.Element?

The last element of the collection.

var lazy: LazyCollection<IndexPath>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

var lazy: LazySequence<IndexPath>

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

var lazy: LazyBidirectionalCollection<IndexPath>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

var lazy: LazyRandomAccessCollection<IndexPath>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

var row: Intvar section: Intvar section: Intvar startIndex: IndexPath.Index
var underestimatedCount: Int

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

var underestimatedCount: Int

Returns a value less than or equal to the number of elements in the sequence, nondestructively.

Instance Methods

func append(IndexPath)

Append an IndexPath to self.

func append(Array<IndexPath.Element>)

Append an array of elements to self.

func append(IndexPath.Element)

Append a single element to self.

func appending(IndexPath.Element)

Return a new IndexPath containing the elements in self and the elements in other.

func appending(IndexPath)

Return a new IndexPath containing the elements in self and the elements in other.

func appending(Array<IndexPath.Element>)

Return a new IndexPath containing the elements in self and the elements in other.

func compare(IndexPath)

Sorting an array of IndexPath using this comparison results in an array representing nodes in depth-first traversal order.

func contains(IndexPath.Element)

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

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

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

func drop(while: (IndexPath.Element) -> Bool)

Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.

func dropFirst()

Returns a subsequence containing all but the first element of the sequence.

func dropFirst(Int)

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

func dropLast()

Return a new IndexPath containing all but the last element.

func dropLast(Int)

Returns a subsequence containing all but the specified number of final elements.

func elementsEqual<OtherSequence>(OtherSequence)

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

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

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

func enumerated()

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 filter((IndexPath.Element) -> Bool)

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

func first(where: (IndexPath.Element) -> Bool)

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

func flatMap<SegmentOfResult>((IndexPath.Element) -> SegmentOfResult)

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

func flatMap<ElementOfResult>((IndexPath.Element) -> ElementOfResult?)

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

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

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

func index(after: IndexPath.Index)func index(before: IndexPath.Index)
func index(of: IndexPath.Element)

Returns the first index where the specified value appears in the collection.

func index(where: (IndexPath.Element) -> Bool)

Returns the first index in which an element of the collection satisfies the given predicate.

func lexicographicallyPrecedes<OtherSequence>(OtherSequence)

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: (IndexPath.Element, IndexPath.Element) -> Bool)

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

func makeIterator()
func map<T>((IndexPath.Element) -> T)

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

func map<T>((IndexPath.Element) -> T)

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

func max()

Returns the maximum element in the sequence.

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

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

func min()

Returns the minimum element in the sequence.

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

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

func partition(by: (IndexPath.Element) -> Bool)func partition(by: (IndexPath.Element) -> Bool)
func popFirst()

Removes and returns the first element of the collection.

func popLast()

Removes and returns the last element of the collection.

func prefix(Int)

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

func prefix(through: Array.Index)

Returns a subsequence from the start of the collection through the specified position.

func prefix(upTo: Array.Index)

Returns a subsequence from the start of the collection up to, but not including, the specified position.

func prefix(while: (IndexPath.Element) -> Bool)

Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.

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

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

func removeFirst()

Removes and returns the first element of the collection.

func removeFirst(Int)

Removes the specified number of elements from the beginning of the collection.

func removeLast()

Removes and returns the last element of the collection.

func removeLast(Int)

Removes the given number of elements from the end of the collection.

func reversed()

Returns a view presenting the elements of the collection in reverse order.

func sort(by: (IndexPath.Element, IndexPath.Element) -> Bool)

Sorts the collection in place, using the given predicate as the comparison between elements.

func sorted()

Returns the elements of the collection, sorted.

func sorted(by: (IndexPath.Element, IndexPath.Element) -> Bool)

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

func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (IndexPath.Element) -> Bool)

Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.

func split(separator: IndexPath.Element, maxSplits: Int, omittingEmptySubsequences: Bool)

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

func starts<PossiblePrefix>(with: PossiblePrefix)

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: (IndexPath.Element, IndexPath.Element) -> 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 suffix(Int)

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

func suffix(from: Array.Index)

Returns a subsequence from the specified position to the end of the collection.