Structure

MLDataTable.Rows

A collection of rows in a data table.

Declaration

struct Rows

Topics

Inspecting a Row Collection

var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

var count: Int

The number of elements in the collection.

Accessing Rows

var first: MLDataTable.Row?

The first element of the collection.

var last: MLDataTable.Row?

The last element of the collection.

func randomElement() -> MLDataTable.Row?

Returns a random element of the collection.

func randomElement<T>(using: inout T) -> MLDataTable.Row?

Returns a random element of the collection, using the given generator as a source for randomness.

subscript(Range<Int>) -> Slice<MLDataTable.Rows>

Accesses a contiguous subrange of the collection’s elements.

subscript<R>(R) -> Slice<MLDataTable.Rows>

Accesses the contiguous subrange of the collection’s elements specified by a range expression.

Finding Rows

func contains(MLDataTable.Row) -> Bool

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

func contains(where: (MLDataTable.Row) -> Bool) -> Bool

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

func allSatisfy((MLDataTable.Row) -> Bool) -> Bool

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

func first(where: (MLDataTable.Row) -> Bool) -> MLDataTable.Row?

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

func firstIndex(of: MLDataTable.Row) -> Int?

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

func firstIndex(where: (MLDataTable.Row) -> Bool) -> Int?

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

func last(where: (MLDataTable.Row) -> Bool) -> MLDataTable.Row?

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

func lastIndex(of: MLDataTable.Row) -> Int?

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

func lastIndex(where: (MLDataTable.Row) -> Bool) -> Int?

Returns the index of the last element in the collection that matches the given predicate.

func min(by: (MLDataTable.Row, MLDataTable.Row) -> Bool) -> MLDataTable.Row?

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

func max(by: (MLDataTable.Row, MLDataTable.Row) -> Bool) -> MLDataTable.Row?

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

Selecting Rows

func filter((MLDataTable.Row) -> Bool) -> [MLDataTable.Row]

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

func prefix(Int) -> Slice<MLDataTable.Rows>

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

func prefix(through: Int) -> Slice<MLDataTable.Rows>

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

func prefix(upTo: Int) -> Slice<MLDataTable.Rows>

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

func prefix(while: (MLDataTable.Row) -> Bool) -> Slice<MLDataTable.Rows>

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

func suffix(Int) -> Slice<MLDataTable.Rows>

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

func suffix(from: Int) -> Slice<MLDataTable.Rows>

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

Excluding Rows

func dropFirst(Int) -> Slice<MLDataTable.Rows>

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

func dropLast(Int) -> Slice<MLDataTable.Rows>

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

func drop(while: (MLDataTable.Row) -> Bool) -> Slice<MLDataTable.Rows>

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

Transforming a Row Collection

func compactMap<ElementOfResult>((MLDataTable.Row) -> 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, MLDataTable.Row) -> Result) -> Result

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

var lazy: LazySequence<MLDataTable.Rows>

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

Iterating Over a Row Collection's Rows

func forEach((MLDataTable.Row) -> Void)

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

func enumerated() -> EnumeratedSequence<MLDataTable.Rows>

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 makeIterator() -> IndexingIterator<MLDataTable.Rows>

Returns an iterator over the elements of the collection.

Reordering a Row Collection's Rows

func sorted(by: (MLDataTable.Row, MLDataTable.Row) -> Bool) -> [MLDataTable.Row]

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

func reversed() -> ReversedCollection<MLDataTable.Rows>

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

func shuffled() -> [MLDataTable.Row]

Returns the elements of the sequence, shuffled.

func shuffled<T>(using: inout T) -> [MLDataTable.Row]

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

Splitting and Joining Rows

func split(separator: MLDataTable.Row, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Slice<MLDataTable.Rows>]

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

func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (MLDataTable.Row) -> Bool) -> [Slice<MLDataTable.Rows>]

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

func joined<Separator>(separator: Separator) -> JoinedSequence<MLDataTable.Rows>

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

Comparing Row 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: (MLDataTable.Row, 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: (MLDataTable.Row, 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, by: (MLDataTable.Row, MLDataTable.Row) -> 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.

Manipulating Indices

func index(after: Int) -> Int

Returns the position immediately after the given index.

func formIndex(after: inout Int)

Replaces the given index with its successor.

func index(before: Int) -> Int

Returns the position immediately after the given index.

func formIndex(before: inout Int)

Replaces the given index with its predecessor.

func index(Int, offsetBy: Int) -> Int

Returns an index that is the specified distance from the given index.

func formIndex(inout Int, offsetBy: Int)

Offsets the given index by the specified distance.

func index(Int, offsetBy: Int, limitedBy: Int) -> Int?

Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.

func formIndex(inout Int, offsetBy: Int, limitedBy: Int) -> Bool

Offsets the given index by the specified distance, or so that it equals the given limiting index.

func distance(from: Int, to: Int) -> Int

Returns the distance between two indices.

var indices: Range<Int>

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

Supporting Types

struct MLDataTable.Row

A row of untyped values in a data table.

Instance Properties

var underestimatedCount: Int

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

Instance Methods

func difference<C>(from: C) -> CollectionDifference<MLDataTable.Row>

Returns the difference needed to produce this collection’s ordered elements from the given collection.

Beta
func difference<C>(from: C, by: (C.Element, MLDataTable.Row) -> Bool) -> CollectionDifference<MLDataTable.Row>

Returns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.

Beta
func flatMap<SegmentOfResult>((MLDataTable.Row) -> SegmentOfResult) -> [SegmentOfResult.Element]

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

func index(of: MLDataTable.Row) -> Int?

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

Deprecated
func joined() -> FlattenSequence<MLDataTable.Rows>

Returns the elements of this sequence of sequences, concatenated.

func map<T>((MLDataTable.Row) -> T) -> [T]

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

func reduce<Result>(into: Result, (inout Result, MLDataTable.Row) -> ()) -> Result

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

func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<MLDataTable.Row>) -> 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.

See Also

Getting Information About a Data Table’s Rows

var rows: MLDataTable.Rows

The rows of data in the table.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software