App Services · IOS API REFERENCE

TabularData

Import, organize, and prepare a table of data to train a machine learning model.

89 types

450 callable entries

130 skipped

78% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AnyCategoricalSummary

struct · iOS 15.0+

AnyColumn

struct · iOS 15.0+

AnyColumn.Element

typealias · iOS 15.0+

AnyColumn.Index

typealias · iOS 15.0+

AnyColumn.Indices

typealias · iOS 15.0+

AnyColumn.Iterator

typealias · iOS 15.0+

AnyColumn.SubSequence

typealias · iOS 15.0+

AnyColumnProtocol

protocol · iOS 15.0+

AnyColumnPrototype

protocol · iOS 15.0+

AnyColumnSlice

struct · iOS 15.0+

AnyColumnSlice.Element

typealias · iOS 15.0+

AnyColumnSlice.Index

typealias · iOS 15.0+

AnyColumnSlice.Indices

typealias · iOS 15.0+

AnyColumnSlice.Iterator

typealias · iOS 15.0+

AnyColumnSlice.SubSequence

typealias · iOS 15.0+

CategoricalSummary

struct · iOS 15.0+

Column

struct · iOS 15.0+

Column.Element

typealias · iOS 15.0+

Column.Index

typealias · iOS 15.0+

Column.Indices

typealias · iOS 15.0+

Column.Iterator

typealias · iOS 15.0+

Column.SubSequence

typealias · iOS 15.0+

ColumnDecodingError

struct · iOS 15.0+

ColumnEncodingError

struct · iOS 15.0+

ColumnID

struct · iOS 15.0+

ColumnProtocol

protocol · iOS 15.0+

ColumnSlice

struct · iOS 15.0+

ColumnSlice.Element

typealias · iOS 15.0+

ColumnSlice.Index

typealias · iOS 15.0+

ColumnSlice.Indices

typealias · iOS 15.0+

ColumnSlice.Iterator

typealias · iOS 15.0+

ColumnSlice.SubSequence

typealias · iOS 15.0+

CSVReadingError

enum · iOS 15.0+

CSVReadingOptions

struct · iOS 15.0+

CSVType

enum · iOS 15.0+

CSVWritingError

enum · iOS 15.0+

CSVWritingOptions

struct · iOS 15.0+

DataFrame

struct · iOS 15.0+

DataFrame.ColumnType

typealias · iOS 15.0+

DataFrame.Key

typealias · iOS 15.0+

DataFrame.Row

struct · iOS 15.0+

DataFrame.Row.Element

typealias · iOS 15.0+

DataFrame.Row.Index

typealias · iOS 15.0+

DataFrame.Row.Indices

typealias · iOS 15.0+

DataFrame.Row.Iterator

typealias · iOS 15.0+

DataFrame.Row.SubSequence

typealias · iOS 15.0+

DataFrame.Rows

struct · iOS 15.0+

DataFrame.Rows.Element

typealias · iOS 15.0+

DataFrame.Rows.Index

typealias · iOS 15.0+

DataFrame.Rows.Indices

typealias · iOS 15.0+

DataFrame.Rows.Iterator

typealias · iOS 15.0+

DataFrame.Rows.SubSequence

typealias · iOS 15.0+

DataFrame.Slice

struct · iOS 15.0+

DataFrame.Slice.ColumnType

typealias · iOS 15.0+

DataFrame.Value

typealias · iOS 15.0+

DataFrameProtocol

protocol · iOS 15.0+

DiscontiguousColumnSlice

struct · iOS 15.0+

DiscontiguousColumnSlice.Element

typealias · iOS 15.0+

DiscontiguousColumnSlice.Index

typealias · iOS 15.0+

DiscontiguousColumnSlice.Indices

typealias · iOS 15.0+

DiscontiguousColumnSlice.Iterator

typealias · iOS 15.0+

DiscontiguousColumnSlice.SubSequence

typealias · iOS 15.0+

FilledColumn

struct · iOS 15.0+

FilledColumn.Element

typealias · iOS 15.0+

FilledColumn.Index

typealias · iOS 15.0+

FilledColumn.Indices

typealias · iOS 15.0+

FilledColumn.Iterator

typealias · iOS 15.0+

FilledColumn.SubSequence

typealias · iOS 15.0+

FilledColumn.WrappedElement

typealias · iOS 15.0+

FormattingOptions

struct · iOS 15.0+

GroupSummaries

protocol · iOS 15.0+

JoinKind

enum · iOS 15.0+

JSONReadingError

enum · iOS 15.0+

JSONReadingOptions

struct · iOS 15.0+

JSONType

enum · iOS 15.0+

JSONWritingOptions

struct · iOS 16.0+

NumericSummary

struct · iOS 15.0+

OptionalColumnProtocol

protocol · iOS 15.0+

Order

enum · iOS 15.0+

RowGrouping

struct · iOS 15.0+

RowGrouping.Element

typealias · iOS 15.0+

RowGrouping.Index

typealias · iOS 15.0+

RowGrouping.Indices

typealias · iOS 15.0+

RowGrouping.Iterator

typealias · iOS 15.0+

RowGrouping.SubSequence

typealias · iOS 15.0+

RowGroupingProtocol

protocol · iOS 15.0+

SFrameReadingError

enum · iOS 15.0+

ShapedData

struct · iOS 15.0+

SummaryColumnIDs

enum · iOS 15.0+

Functions and constants

init · iOS 15.0+

init

TypeScript

static init(shape: Array<number>, strides: Array<number>, contents: Array<unknown>): ShapedData<unknown>

Swift declaration

init(shape: [Int], strides: [Int], contents: [Element])

Creates a multidimensional shaped array from a one-dimensional array. - Parameters: - shape: An integer array that stores the size of each dimension in the corresponding element. - strides: An integer array that stores the number of memory locations that span the length of each dimension in the corresponding element. - contents: A linear array that stores the elements of the multidimensional array.

get · iOS 15.0+

shape

TypeScript

get shape(): Array<number>

Swift declaration

let shape: [Int]

An integer array that stores the size of each dimension in the corresponding element.

get · iOS 15.0+

strides

TypeScript

get strides(): Array<number>

Swift declaration

let strides: [Int]

An integer array that stores the number of memory locations that span the length of each dimension in the corresponding element.

get · iOS 15.0+

TypeScript

get contents(): Array<unknown>

Swift declaration

let contents: [Element]

A linear array that stores the elements of the multidimensional array.

method · iOS 15.0+

eraseToAnyColumn

TypeScript

eraseToAnyColumn(): AnyColumnSlice

Swift declaration

func eraseToAnyColumn() -> AnyColumnSlice

Returns a type-erased column slice.

get · iOS 15.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: Int { get }

The index of the initial element in the column slice.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A text representation of the column slice.

get · iOS 15.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

var customMirror: Mirror { get }

A mirror that reflects the column slice.

get · iOS 15.0+

missingCount

TypeScript

get missingCount(): number

Swift declaration

var missingCount: Int { get }

The number of missing elements in the column slice.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the column slice suitable for debugging.

method · iOS 15.0+

map

TypeScript

map(transform: ((arg0: (unknown) | null) => (unknown) | null)): Column<unknown>

Swift declaration

func map<T>(_ transform: (ColumnSlice<WrappedElement>.Element) throws -> T?) rethrows -> Column<T>

Creates a new column by applying a transformation to every element. - Parameter transform: The transformation closure.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String { get set }

The name of the slice's parent column.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String { get set }

The name of the slice's parent column.

get · iOS 15.0+

count

TypeScript

get count(): number

Swift declaration

var count: Int { get }

The number of elements in the column slice.

method · iOS 15.0+

index

TypeScript

indexAfter(i: number): number

Swift declaration

func index(after i: Int) -> Int

Returns the index immediately after an element index. - Parameter i: A valid index to an element in the column slice.

method · iOS 15.0+

index

TypeScript

indexBefore(i: number): number

Swift declaration

func index(before i: Int) -> Int

Returns the index immediately before an element index. - Parameter i: A valid index to an element in the column slice.

method · iOS 15.0+

isNil

TypeScript

isNil(index: number): boolean

Swift declaration

func isNil(at index: Int) -> Bool

Returns a Boolean that indicates whether the element at an index is missing. - Parameter index: An element index.

method · iOS 15.0+

filter

TypeScript

filter(isIncluded: ((arg0: (unknown) | null) => boolean)): DiscontiguousColumnSlice<unknown>

Swift declaration

func filter(_ isIncluded: (ColumnSlice<WrappedElement>.Element) throws -> Bool) rethrows -> DiscontiguousColumnSlice<WrappedElement>

Generates a slice that contains the elements that satisfy the predicate. - Parameter isIncluded: The filter predicate. Elements for which the predicate returns `true` are included.

get · iOS 15.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: Int { get }

The index of the final element in the column slice.

get · iOS 15.0+

prototype

TypeScript

get prototype(): SDKHandle

Swift declaration

var prototype: any AnyColumnPrototype { get }

A prototype that creates type-erased columns with the same underlying type as the column slice. Use a type-erased column prototype to create new columns of the same type as the slice's parent column without explicitly knowing what type it is.

method · iOS 15.0+

numericSummary

TypeScript

numericSummary(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<WrappedElement>

Generates a numeric summary of the floating-point column slice's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> ColumnSlice<WrappedElement>.Element

Returns the standard deviation of the floating-point column slice's elements, ignoring missing elements. - Parameter deltaDegreesOfFreedom: A nonnegative integer. The method calculates the standard deviation's divisor by subtracting this parameter from the number of non-`nil` elements (`n - deltaDegreesOfFreedom` where `n` is the number of non-`nil` elements). - Returns: The standard deviation; otherwise, `nil` if there are fewer than `deltaDegreesOfFreedom + 1` non-`nil` items in the column.

method · iOS 15.0+

mean

TypeScript

mean(): (number) | null

Swift declaration

func mean() -> ColumnSlice<WrappedElement>.Element

Returns the mean average of the floating-point slice's elements, ignoring missing elements.

method · iOS 15.0+

summary

TypeScript

summary(): CategoricalSummary<number>

Swift declaration

func summary() -> CategoricalSummary<WrappedElement>

Generates a categorical summary of the column slice's elements.

method · iOS 15.0+

distinct

TypeScript

distinct(): DiscontiguousColumnSlice<number>

Swift declaration

func distinct() -> DiscontiguousColumnSlice<WrappedElement>

Generates a discontiguous slice that contains unique elements. The method only adds the first of multiple elements with the same value --- the element with the smallest index --- to the slice. - Returns: A discontiguous column slice.

method · iOS 15.0+

numericSummary

TypeScript

numericSummary947(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<Double>

Generates a numeric summary of the integer column slice's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom66200(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> Double?

Returns the standard deviation of the integer column slice's elements, ignoring missing elements. - Parameter deltaDegreesOfFreedom: A nonnegative integer. The method calculates the standard deviation's divisor by subtracting this parameter from the number of non-`nil` elements (`n - deltaDegreesOfFreedom` where `n` is the number of non-`nil` elements). - Returns: The standard deviation; otherwise, `nil` if there are fewer than `deltaDegreesOfFreedom + 1` non-`nil` items in the column.

method · iOS 15.0+

mean

TypeScript

mean65126(): (number) | null

Swift declaration

func mean() -> Double?

Returns the mean average of the integer slice's elements, ignoring missing elements.

method · iOS 15.0+

sum

TypeScript

sum(): number

Swift declaration

func sum() -> WrappedElement

Returns the sum of the column slice's elements, ignoring missing elements.

init · iOS 15.0+

init

TypeScript

static init(column: Column<unknown>): ColumnSlice<unknown>

Swift declaration

init(_ column: Column<WrappedElement>)

Creates a slice with the contents of a column. - Parameter column: A column.

subscript · iOS 15.0+

subscript

TypeScript

subscript(range: SDKHandle): ColumnSlice<unknown>

Swift declaration

subscript(range: Range<Int>) -> ColumnSlice<WrappedElement> { get set }

Accesses a contiguous range of elements. - Parameter range: A range of valid indices in the column slice.

subscript · iOS 15.0+

subscript

TypeScript

subscript44104(position: number): (unknown) | null

Swift declaration

subscript(position: Int) -> ColumnSlice<WrappedElement>.Element { get set }

Accesses an element at an index. - Parameter position: A valid index to an element in the column slice.

get · iOS 15.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: Int { get }

The index of the initial group in the row grouping.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A text representation of the row grouping.

method · iOS 15.0+

randomSplit

TypeScript

randomSplit(proportion: number, seed?: (number) | null): [RowGrouping<number>, RowGrouping<number>]

Swift declaration

func randomSplit(by proportion: Double, seed: Int? = nil) -> (RowGrouping<GroupingKey>, RowGrouping<GroupingKey>)

Generates two row groupings by randomly splitting the original with a proportion and a seed number. - Parameters: - proportion: A proportion in the range `[0.0, 1.0]`. - seed: A seed number for a random-number generator. - Returns: A tuple of two row groupings.

get · iOS 15.0+

count

TypeScript

get count(): number

Swift declaration

var count: Int { get }

The number of groups in the row grouping.

method · iOS 15.0+

index

TypeScript

indexAfter(i: number): number

Swift declaration

func index(after i: Int) -> Int

Returns the index immediately after an element index. - Parameter i: A valid index to an element in the column.

method · iOS 15.0+

index

TypeScript

indexBefore(i: number): number

Swift declaration

func index(before i: Int) -> Int

Returns the index immediately before an element index. - Parameter i: A valid index to an element in the column.

method · iOS 15.0+

counts

TypeScript

counts(order?: (Order) | null): DataFrame

Swift declaration

func counts(order: Order? = nil) -> DataFrame

Generates a data frame with two columns, one that has a row for each group key and another for the number of rows in the group. - Parameter order: A sorting order the method uses to sort the data frame by its count column. The name of the data frame's column that stores the number of rows in each group is *count*.

method · iOS 15.4+

filter

TypeScript

filter(isIncluded: ((arg0: DataFrame_Slice) => boolean)): RowGrouping<number>

Swift declaration

func filter(_ isIncluded: (DataFrame.Slice) throws -> Bool) rethrows -> RowGrouping<GroupingKey>

Returns a row grouping containing only the groups that satisfy a predicate. - Parameter isIncluded: A predicate closure that takes a group and returns a Boolean that indicates whether the group is included. - Returns: A data frame slice that contains the rows that satisfy the predicate.

method · iOS 15.0+

summary

TypeScript

summaryOf(columnNames: Array<string>): SDKHandle

Swift declaration

func summary(of columnNames: [String]) -> any GroupSummaries

Generates a group summaries instance for the columns you select by name. - Parameter columnNames: An array of column names.

method · iOS 15.0+

summary

TypeScript

summary(): SDKHandle

Swift declaration

func summary() -> any GroupSummaries

Generates a group summaries instance for the columns of the row grouping.

get · iOS 15.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: Int { get }

The index of the final group in the row grouping.

method · iOS 15.0+

mapGroups

TypeScript

mapGroups(transform: ((arg0: DataFrame_Slice) => DataFrame)): RowGrouping<number>

Swift declaration

func mapGroups(_ transform: (DataFrame.Slice) throws -> DataFrame) rethrows -> RowGrouping<GroupingKey>

Generates a row grouping that applies a transformation closure to each group in the original. - Parameter transform: A closure that generates a data frame from a data frame slice that represents a group.

method · iOS 15.0+

ungrouped

TypeScript

ungrouped(): DataFrame

Swift declaration

func ungrouped() -> DataFrame

Generates a data frame that contains all the rows from each group in the row grouping. The method discards any column with the same name as the row grouping itself.

subscript · iOS 15.0+

subscript

TypeScript

subscript(position: number): { "key": (number) | null; "group": DataFrame_Slice }

Swift declaration

subscript(position: Int) -> (key: GroupingKey?, group: DataFrame.Slice) { get }

Retrieves a group at an index. - Parameter position: A valid index to a group in the row grouping.

method · iOS 15.0+

description

TypeScript

descriptionOptions(options: FormattingOptions): string

Swift declaration

func description(options: FormattingOptions) -> String

Generates a string description of the filled column. - Parameter options: The formatting options.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A mirror that reflects the filled column.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the filled column suitable for debugging.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String { get set }

The name of the column.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String { get set }

The name of the column.

get · iOS 15.0+

totalCount

TypeScript

get totalCount(): number

Swift declaration

var totalCount: Int { get }

The total number of elements in the column.

get · iOS 15.0+

firstQuartile

TypeScript

get firstQuartile(): number

Swift declaration

var firstQuartile: Element

The value that's above 25% of the non-missing elements' values.

set · iOS 15.0+

firstQuartile

TypeScript

set firstQuartile(value: number)

Swift declaration

var firstQuartile: Element

The value that's above 25% of the non-missing elements' values.

get · iOS 15.0+

thirdQuartile

TypeScript

get thirdQuartile(): number

Swift declaration

var thirdQuartile: Element

The value that's above 75% of the non-missing elements' values.

set · iOS 15.0+

thirdQuartile

TypeScript

set thirdQuartile(value: number)

Swift declaration

var thirdQuartile: Element

The value that's above 75% of the non-missing elements' values.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the summary's statistics suitable for debugging.

get · iOS 15.0+

standardDeviation

TypeScript

get standardDeviation(): number

Swift declaration

var standardDeviation: Element

The standard deviation of a column's values that excludes missing elements.

set · iOS 15.0+

standardDeviation

TypeScript

set standardDeviation(value: number)

Swift declaration

var standardDeviation: Element

The standard deviation of a column's values that excludes missing elements.

get · iOS 15.0+

max

TypeScript

get max(): number

Swift declaration

var max: Element

The largest value, excluding missing elements.

set · iOS 15.0+

max

TypeScript

set max(value: number)

Swift declaration

var max: Element

The largest value, excluding missing elements.

get · iOS 15.0+

min

TypeScript

get min(): number

Swift declaration

var min: Element

The smallest value, excluding missing elements.

set · iOS 15.0+

min

TypeScript

set min(value: number)

Swift declaration

var min: Element

The smallest value, excluding missing elements.

get · iOS 15.0+

mean

TypeScript

get mean(): number

Swift declaration

var mean: Element

The arithmetic mean of a column's values that excludes missing elements.

set · iOS 15.0+

mean

TypeScript

set mean(value: number)

Swift declaration

var mean: Element

The arithmetic mean of a column's values that excludes missing elements.

get · iOS 15.0+

median

TypeScript

get median(): number

Swift declaration

var median: Element

The midpoint value that's above half of the non-missing elements' values and below the other half's values.

set · iOS 15.0+

median

TypeScript

set median(value: number)

Swift declaration

var median: Element

The midpoint value that's above half of the non-missing elements' values and below the other half's values.

get · iOS 15.0+

noneCount

TypeScript

get noneCount(): number

Swift declaration

var noneCount: Int

The number of missing elements in the column.

set · iOS 15.0+

noneCount

TypeScript

set noneCount(value: number)

Swift declaration

var noneCount: Int

The number of missing elements in the column.

init · iOS 15.0+

init

TypeScript

static initSomeCountNoneCountMeanStandardDeviationMinMaxMedianFirstQuartileThirdQuartile(someCount: number, noneCount: number, mean: number, standardDeviation: number, min: number, max: number, median: number, firstQuartile: number, thirdQuartile: number): NumericSummary<number>

Swift declaration

init(someCount: Int, noneCount: Int, mean: Element, standardDeviation: Element, min: Element, max: Element, median: Element, firstQuartile: Element, thirdQuartile: Element)

Creates an empty numeric summary. - Parameters: - someCount: The number of elements in column, excluding missing elements. - noneCount: The number of missing elements in the column. - mean: The arithmetic mean of a column's values, excluding missing elements. - standardDeviation: The standard deviation of a column's values, excluding missing elements. - min: The smallest value, excluding missing elements. - max: The largest value, excluding missing elements. - median: The midpoint value that bisects the values of the non-missing elements. - firstQuartile: The value that's above 25% of the values non-missing elements' values. - thirdQuartile: The value that's above 75% of the non-missing elements' values.

get · iOS 15.0+

someCount

TypeScript

get someCount(): number

Swift declaration

var someCount: Int

The number of non-missing elements in the column.

set · iOS 15.0+

someCount

TypeScript

set someCount(value: number)

Swift declaration

var someCount: Int

The number of non-missing elements in the column.

init · iOS 15.0+

init

TypeScript

static init(): NumericSummary<number>

Swift declaration

init()

Creates an empty numeric summary with default values.

get · iOS 15.0+

totalCount

TypeScript

get totalCount(): number

Swift declaration

var totalCount: Int { get }

The total number of elements in the column.

get · iOS 15.0+

uniqueCount

TypeScript

get uniqueCount(): number

Swift declaration

var uniqueCount: Int

The number of elements with distinct values in a column that excludes missing elements.

set · iOS 15.0+

uniqueCount

TypeScript

set uniqueCount(value: number)

Swift declaration

var uniqueCount: Int

The number of elements with distinct values in a column that excludes missing elements.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the summary's statistics suitable for debugging.

get · iOS 15.0+

mode

TypeScript

get mode(): Array<number>

Swift declaration

var mode: [Element]

The most common values in a column, ignoring missing elements. The summary orders the elements based on their original locations within the column.

set · iOS 15.0+

mode

TypeScript

set mode(value: Array<number>)

Swift declaration

var mode: [Element]

The most common values in a column, ignoring missing elements. The summary orders the elements based on their original locations within the column.

get · iOS 15.0+

noneCount

TypeScript

get noneCount(): number

Swift declaration

var noneCount: Int

The number of missing elements in the column.

set · iOS 15.0+

noneCount

TypeScript

set noneCount(value: number)

Swift declaration

var noneCount: Int

The number of missing elements in the column.

init · iOS 15.0+

init

TypeScript

static initSomeCountNoneCountUniqueCountMode(someCount: number, noneCount: number, uniqueCount: number, mode: Array<number>): CategoricalSummary<number>

Swift declaration

init(someCount: Int, noneCount: Int, uniqueCount: Int, mode: [Element])

Creates a categorical summary. - Parameters: - someCount: The number of elements in a column, excluding missing elements. - noneCount: The number of missing elements in the column. - uniqueCount: The number of elements with distinct values in a column, ignoring missing elements. - mode: The most common values in a column, ignoring missing elements.

get · iOS 15.0+

someCount

TypeScript

get someCount(): number

Swift declaration

var someCount: Int

The number of non-missing elements in the column.

set · iOS 15.0+

someCount

TypeScript

set someCount(value: number)

Swift declaration

var someCount: Int

The number of non-missing elements in the column.

init · iOS 15.0+

init

TypeScript

static init(): CategoricalSummary<number>

Swift declaration

init()

Creates a categorical summary with default values.

method · iOS 15.0+

eraseToAnyColumn

TypeScript

eraseToAnyColumn(): AnyColumnSlice

Swift declaration

func eraseToAnyColumn() -> AnyColumnSlice

Generates a type-erased copy of the column slice.

get · iOS 15.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: Int { get }

The index of the initial element in the column slice.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A text representation of the column slice.

get · iOS 15.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

var customMirror: Mirror { get }

A mirror that reflects the column slice.

get · iOS 15.0+

missingCount

TypeScript

get missingCount(): number

Swift declaration

var missingCount: Int { get }

The number of missing elements in the column slice.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the column slice suitable for debugging.

method · iOS 15.0+

map

TypeScript

map(transform: ((arg0: (unknown) | null) => (unknown) | null)): Column<unknown>

Swift declaration

func map<T>(_ transform: (DiscontiguousColumnSlice<WrappedElement>.Element) throws -> T?) rethrows -> Column<T>

Creates a new column by applying a transformation to each element. - Parameter transform: A closure that transforms the column slice's elements to another type.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String { get set }

The name of the slice's parent column.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String { get set }

The name of the slice's parent column.

get · iOS 15.0+

count

TypeScript

get count(): number

Swift declaration

var count: Int { get }

The number of elements in the column slice.

method · iOS 15.0+

index

TypeScript

indexAfter(i: number): number

Swift declaration

func index(after i: Int) -> Int

Returns the index immediately after an element index. - Parameter i: A valid index to an element in the column slice.

method · iOS 15.0+

index

TypeScript

indexBefore(i: number): number

Swift declaration

func index(before i: Int) -> Int

Returns the index immediately before an element index. - Parameter i: A valid index to an element in the column slice.

method · iOS 15.0+

isNil

TypeScript

isNil(index: number): boolean

Swift declaration

func isNil(at index: Int) -> Bool

Returns a Boolean that indicates whether the element at the index is missing. - Parameter index: An index.

init · iOS 15.0+

init

TypeScript

static initColumnRanges(column: Column<unknown>, ranges: Array<SDKHandle>): DiscontiguousColumnSlice<unknown>

Swift declaration

init(column: Column<WrappedElement>, ranges: [Range<Int>])

Creates a slice with the contents of a column. - Parameter column: A column. - Parameter ranges: An array of integer ranges.

method · iOS 15.0+

filter

TypeScript

filter(isIncluded: ((arg0: (unknown) | null) => boolean)): DiscontiguousColumnSlice<unknown>

Swift declaration

func filter(_ isIncluded: (DiscontiguousColumnSlice<WrappedElement>.Element) throws -> Bool) rethrows -> DiscontiguousColumnSlice<WrappedElement>

Generates a slice that contains the elements that satisfy the predicate. - Parameter isIncluded: A predicate closure that returns a Boolean. The method uses the closure to determine whether it includes an element in the slice.

get · iOS 15.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: Int { get }

The index of the final element in the column slice.

get · iOS 15.0+

prototype

TypeScript

get prototype(): SDKHandle

Swift declaration

var prototype: any AnyColumnPrototype { get }

method · iOS 15.0+

numericSummary

TypeScript

numericSummary(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<WrappedElement>

Generates a numeric summary of the floating-point column slice's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> DiscontiguousColumnSlice<WrappedElement>.Element

method · iOS 15.0+

mean

TypeScript

mean(): (number) | null

Swift declaration

func mean() -> DiscontiguousColumnSlice<WrappedElement>.Element

Returns the mean average of the floating-point slice's elements, ignoring missing elements.

method · iOS 15.0+

summary

TypeScript

summary(): CategoricalSummary<number>

Swift declaration

func summary() -> CategoricalSummary<WrappedElement>

Generates a categorical summary of the column slice's elements.

method · iOS 15.0+

distinct

TypeScript

distinct(): DiscontiguousColumnSlice<number>

Swift declaration

func distinct() -> DiscontiguousColumnSlice<WrappedElement>

method · iOS 15.0+

numericSummary

TypeScript

numericSummary56122(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<Double>

Generates a numeric summary of the integer column slice's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom29806(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> Double?

method · iOS 15.0+

mean

TypeScript

mean60696(): (number) | null

Swift declaration

func mean() -> Double?

Returns the mean average of the integer slice's elements, ignoring missing elements.

method · iOS 15.0+

sum

TypeScript

sum(): number

Swift declaration

func sum() -> WrappedElement

Returns the sum of the column slice's elements, ignoring missing elements.

init · iOS 15.0+

init

TypeScript

static init(column: Column<unknown>): DiscontiguousColumnSlice<unknown>

Swift declaration

init(_ column: Column<WrappedElement>)

Creates a slice with the contents of a column. - Parameter column: A column.

subscript · iOS 15.0+

subscript

TypeScript

subscript(range: SDKHandle): DiscontiguousColumnSlice<unknown>

Swift declaration

subscript(range: Range<Int>) -> DiscontiguousColumnSlice<WrappedElement> { get set }

Accesses a contiguous range of elements. - Parameter range: A range of valid indices in the column slice.

subscript · iOS 15.0+

subscript

TypeScript

subscript93698(range: SDKHandle): DiscontiguousColumnSlice<unknown>

Swift declaration

subscript<R>(range: R) -> DiscontiguousColumnSlice<WrappedElement> where R : RangeExpression, R.Bound == Int { get set }

Accesses a contiguous range of elements with a range expression. - Parameter range: A range expression of valid indices in the column slice.

subscript · iOS 15.0+

subscript

TypeScript

subscript82204(range: SDKHandle): DiscontiguousColumnSlice<unknown>

Swift declaration

subscript(range: UnboundedRange) -> DiscontiguousColumnSlice<WrappedElement> { get set }

Accesses a contiguous range of elements with an unbounded range. - Parameter range: An unbounded range of valid indices in the column slice.

subscript · iOS 15.0+

subscript

TypeScript

subscript57566(position: number): (unknown) | null

Swift declaration

subscript(position: Int) -> DiscontiguousColumnSlice<WrappedElement>.Element { get set }

Accesses an element at an index. - Parameter position: A valid index to an element in the column slice.

method · iOS 15.0+

eraseToAnyColumn

TypeScript

eraseToAnyColumn(): AnyColumn

Swift declaration

func eraseToAnyColumn() -> AnyColumn

Generates a type-erased copy of the column.

get · iOS 15.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: Int { get }

The index of the initial element in the column.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A text representation of the column.

get · iOS 15.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

var customMirror: Mirror { get }

A mirror that reflects the column.

get · iOS 15.0+

missingCount

TypeScript

get missingCount(): number

Swift declaration

var missingCount: Int { get }

The number of missing elements in the column.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A text representation of the column suitable for debugging.

method · iOS 16.0+

withContiguousStorageIfAvailable

TypeScript

withContiguousStorageIfAvailable(body: ((arg0: unknown[]) => unknown)): (unknown) | null

Swift declaration

func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<WrappedElement>) throws -> R) rethrows -> R?

Call `body(buffer)`, where `buffer` provides access to the non-optional contiguous storage of the entire column. If the column contains missing values, `body` is not called and `nil` is returned. The optimizer can often eliminate bounds- and uniqueness-checking within an algorithm. When that fails, however, invoking the same algorithm on `body`'s argument may let you trade safety for speed. - Parameters: - body: a closure to be executed using the elements of this collection. - buffer: a buffer to the contiguous storage of this collection. - Returns: the value returned by `body`, or `nil`.

method · iOS 16.0+

withContiguousMutableStorageIfAvailable

TypeScript

withContiguousMutableStorageIfAvailable(body: ((arg0: unknown[]) => unknown)): (unknown) | null

Swift declaration

mutating func withContiguousMutableStorageIfAvailable<R>(_ body: (inout UnsafeMutableBufferPointer<WrappedElement>) throws -> R) rethrows -> R?

Call `body(buffer)`, where `buffer` provides access to the non-optional contiguous mutable storage of the entire column. If the column contains missing values, `body` is not called and `nil` is returned. The optimizer can often eliminate bounds- and uniqueness-checking within an algorithm. When that fails, however, invoking the same algorithm on `body`'s argument may let you trade safety for speed. - Note: `buffer` must not be replaced by `body`. - Parameters: - body: a closure to be executed using the elements of this collection. - buffer: a buffer to the mutable contiguous storage of this collection. - Returns: the value returned by `body`, or `nil`.

method · iOS 15.0+

map

TypeScript

map(transform: ((arg0: (unknown) | null) => (unknown) | null)): Column<unknown>

Swift declaration

func map<T>(_ transform: (Column<WrappedElement>.Element) throws -> T?) rethrows -> Column<T>

Creates a new column by applying a transformation to every element. - Parameter transform: A transformation closure.

init · iOS 15.0+

init

TypeScript

static initNameCapacity(name: string, capacity: number): Column<unknown>

Swift declaration

init(name: String, capacity: Int)

Creates a column with a name and a capacity. - Parameters: - name: A column name. - capacity: An integer that represents the number of elements the column can initially store.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String

The name of the column.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String

The name of the column.

get · iOS 15.0+

count

TypeScript

get count(): number

Swift declaration

var count: Int { get }

The number of elements in the column.

method · iOS 15.0+

index

TypeScript

indexAfter(i: number): number

Swift declaration

func index(after i: Int) -> Int

Returns the index immediately after an element index. - Parameter i: A valid index to an element in the column.

method · iOS 15.0+

index

TypeScript

indexBefore(i: number): number

Swift declaration

func index(before i: Int) -> Int

Returns the index immediately before an element index. - Parameter i: A valid index to an element in the column.

method · iOS 15.0+

append

TypeScript

append(element: unknown): void

Swift declaration

mutating func append(_ element: WrappedElement)

Appends a nonoptional value to the column. - Parameter element: An optional element.

method · iOS 15.0+

append

TypeScript

append63987(element: (unknown) | null): void

Swift declaration

mutating func append(_ element: Column<WrappedElement>.Element)

Appends an optional value to the column. - Parameter element: A nonoptional element.

method · iOS 15.0+

filter

TypeScript

filter(isIncluded: ((arg0: (unknown) | null) => boolean)): DiscontiguousColumnSlice<unknown>

Swift declaration

func filter(_ isIncluded: (Column<WrappedElement>.Element) throws -> Bool) rethrows -> DiscontiguousColumnSlice<WrappedElement>

Generates a slice that contains the elements that satisfy a predicate. - Parameter isIncluded: A predicate closure that returns a Boolean. The method uses the closure to determine whether it includes an element in the slice.

method · iOS 15.0+

remove

TypeScript

remove(index: number): void

Swift declaration

mutating func remove(at index: Int)

Removes an element from the column. - Parameter index: The element's location in the column.

get · iOS 15.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: Int { get }

The index of the final element in the column.

method · iOS 15.0+

mapNonNil

TypeScript

mapNonNil(transform: ((arg0: unknown) => (unknown) | null)): Column<unknown>

Swift declaration

func mapNonNil<T>(_ transform: (WrappedElement) throws -> T?) rethrows -> Column<T>

Creates a new column by applying the transformation to every element that isn't missing. - Parameter transform: A transformation closure.

get · iOS 15.0+

prototype

TypeScript

get prototype(): SDKHandle

Swift declaration

var prototype: any AnyColumnPrototype { get }

method · iOS 15.0+

transform

TypeScript

transform(transform: ((arg0: (unknown) | null) => (unknown) | null)): void

Swift declaration

mutating func transform(_ transform: (Column<WrappedElement>.Element) throws -> Column<WrappedElement>.Element) rethrows

Applies a transformation to every element in the column. - Parameter transform: A transformation closure.

method · iOS 15.0+

transform

TypeScript

transform60933(transform: ((arg0: unknown) => unknown)): void

Swift declaration

mutating func transform(_ transform: (WrappedElement) throws -> WrappedElement) rethrows

Applies a transformation to every element that isn't missing. - Parameter transform: A transformation closure.

method · iOS 15.0+

numericSummary

TypeScript

numericSummary(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<WrappedElement>

Generates a numeric summary of the floating-point column's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> Column<WrappedElement>.Element

Returns the standard deviation of the floating-point column's elements, ignoring missing elements. - Parameter deltaDegreesOfFreedom: A nonnegative integer. The method calculates the standard deviation's divisor by subtracting this parameter from the number of non-`nil` elements (`n - deltaDegreesOfFreedom` where `n` is the number of non-`nil` elements). - Returns: The standard deviation; otherwise, `nil` if there are fewer than `deltaDegreesOfFreedom + 1` non-`nil` items in the column.

method · iOS 15.0+

mean

TypeScript

mean(): (number) | null

Swift declaration

func mean() -> Column<WrappedElement>.Element

Returns the mean average of the floating-point column's elements, ignoring missing elements.

method · iOS 15.0+

summary

TypeScript

summary(): CategoricalSummary<number>

Swift declaration

func summary() -> CategoricalSummary<WrappedElement>

Generates a categorical summary of the column's elements.

method · iOS 15.0+

distinct

TypeScript

distinct(): DiscontiguousColumnSlice<number>

Swift declaration

func distinct() -> DiscontiguousColumnSlice<WrappedElement>

method · iOS 15.0+

numericSummary

TypeScript

numericSummary83584(): NumericSummary<number>

Swift declaration

func numericSummary() -> NumericSummary<Double>

Generates a numeric summary of the integer column's elements.

method · iOS 15.0+

standardDeviation

TypeScript

standardDeviationDeltaDegreesOfFreedom81666(deltaDegreesOfFreedom?: number): (number) | null

Swift declaration

func standardDeviation(deltaDegreesOfFreedom: Int = 1) -> Double?

Returns the standard deviation of the integer column's elements, ignoring missing elements. - Parameter deltaDegreesOfFreedom: A nonnegative integer. The method calculates the standard deviation's divisor by subtracting this parameter from the number of non-`nil` elements (`n - deltaDegreesOfFreedom` where `n` is the number of non-`nil` elements). - Returns: The standard deviation; otherwise, `nil` if there are fewer than `deltaDegreesOfFreedom + 1` non-`nil` items in the column.

method · iOS 15.0+

mean

TypeScript

mean26908(): (number) | null

Swift declaration

func mean() -> Double?

Returns the mean average of the integer column's elements, ignoring missing elements.

method · iOS 15.0+

sum

TypeScript

sum(): number

Swift declaration

func sum() -> WrappedElement

Returns the sum of the column's elements, ignoring missing elements.

init · iOS 15.0+

init

TypeScript

static initCapacity(id: ColumnID<unknown>, capacity: number): Column<unknown>

Swift declaration

init(_ id: ColumnID<WrappedElement>, capacity: Int)

Creates a column with a column identifier and a capacity. - Parameters: - id: A column identifier. - capacity: An integer that represents the number of elements the column can initially store.

subscript · iOS 15.0+

subscript

TypeScript

subscript(mask: Array<boolean>): DiscontiguousColumnSlice<unknown>

Swift declaration

subscript<C>(mask: C) -> DiscontiguousColumnSlice<WrappedElement> where C : Collection, C.Element == Bool { get }

Returns a column slice that includes elements that correspond to a collection of Booleans. - Parameter mask: A Boolean collection. The subscript returns a slice that includes the column elements that correspond to the `true` elements in `mask`. You can create a Boolean column for this subscript by comparing a column to a value of the column elements' type. ```swift let followerColumn = artists["Followers", Int.self].filled(with: 0) let popularArtists = artists[followerColumn > 10_000_000] ```

subscript · iOS 15.0+

subscript

TypeScript

subscript44431(bounds: SDKHandle): ColumnSlice<unknown>

Swift declaration

subscript(bounds: Range<Int>) -> ColumnSlice<WrappedElement> { get set }

Accesses a contiguous range of elements. - Parameter bounds: A range of valid indices in the column.

subscript · iOS 15.0+

subscript

TypeScript

subscript5224(range: SDKHandle): ColumnSlice<unknown>

Swift declaration

subscript<R>(range: R) -> ColumnSlice<WrappedElement> where R : RangeExpression, R.Bound == Int { get set }

Accesses a contiguous range of elements with a range expression. - Parameter range: An integer range expression that represents valid indices in the column.

init · iOS 15.0+

init

TypeScript

static init(slice: ColumnSlice<unknown>): Column<unknown>

Swift declaration

init(_ slice: ColumnSlice<WrappedElement>)

Creates a column from a column slice. - Parameter slice: A column slice.

subscript · iOS 15.0+

subscript

TypeScript

subscript52386(position: number): (unknown) | null

Swift declaration

subscript(position: Int) -> Column<WrappedElement>.Element { get set }

Accesses an element at an index. - Parameter position: A valid index to an element in the column.

get · iOS 15.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A text representation of the column identifier.

get · iOS 15.0+

name

TypeScript

get name(): string

Swift declaration

var name: String

The name of the column the identifier represents.

set · iOS 15.0+

name

TypeScript

set name(value: string)

Swift declaration

var name: String

The name of the column the identifier represents.

Skipped declarations

130 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

DataFrame.containsColumn(_:_:)

Passing a Swift type itself is not supported.

DataFrame.append(row:)

A variable number of Swift arguments is not supported.

DataFrame.filter(on:_:_:)

Passing a Swift type itself is not supported.

DataFrame.selecting(columnNames:)

A variable number of Swift arguments is not supported.

DataFrame.subscript(_:_:)

Passing a Swift type itself is not supported.

DataFrame.subscript(column:_:)

Passing a Swift type itself is not supported.

DataFrame.init(dictionaryLiteral:)

A variable number of Swift arguments is not supported.

DataFrameProtocol.randomSplit(by:using:)

This declaration needs Swift generic type arguments. (no canonical witness for G)

DataFrameProtocol.stratifiedSplit(on:by:randomSeed:)

A variable number of Swift arguments is not supported.

FilledColumn.summary()

The containing type needs Swift generic type arguments. (no canonical witness for Base)

JSONReadingOptions.addDateParseStrategy(_:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

JSONWritingOptions.dateFormatter

closure property answers its caller

DataFrame.Slice.subscript(_:_:)

Passing a Swift type itself is not supported.

DataFrame.Slice.subscript(column:_:)

Passing a Swift type itself is not supported.

DataFrame.Slice.filter(on:_:_:)

Passing a Swift type itself is not supported.

DataFrame.Slice.selecting(columnNames:)

A variable number of Swift arguments is not supported.

Column.wrappedElementType

Passing a Swift type itself is not supported.

Column.init(name:contents:)

This declaration needs Swift generic type arguments. (no canonical witness for WrappedElement)

Column.init(name:contents:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

Column.init(_:contents:)

This declaration needs Swift generic type arguments. (no canonical witness for WrappedElement)

Column.init(_:contents:)

This declaration needs Swift generic type arguments. (no canonical witness for S.Element)

Column.append(contentsOf:)

This declaration needs Swift generic type arguments. (no canonical witness for WrappedElement)

Column.append(contentsOf:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

Column.withContiguousStorageIfAvailable(_:)

This output pointer cannot safely be represented by the bridge.

Column.withContiguousMutableStorageIfAvailable(_:)

This output pointer cannot safely be represented by the bridge.

ColumnID.type

Passing a Swift type itself is not supported.

ColumnID.init(_:_:)

Passing a Swift type itself is not supported.

ColumnSlice.wrappedElementType

Passing a Swift type itself is not supported.

DataFrame.summary(of:)

A variable number of Swift arguments is not supported.

DataFrame.summary(ofColumns:)

A variable number of Swift arguments is not supported.