Skip to content
OFFICIAL SS DOCUMENTATION

SS.Tables 1.2.0

Owned typed scientific tables, budgeted streaming grouping and joins, versioned columnar serialization, schema validation, stable row operations, RFC-4180-style CSV, time series and chunk reductions
API 1.2.0
MIT
source

Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0

No package dependencies declared.

Public API

Public signature
export function appendChunk(StreamAccumulator state, double[] values, bool[] missingMask)->StreamAccumulator

Parameters: state: StreamAccumulator, values: double[], missingMask: bool[]


Public signature
export function booleanColumn(string name, bool[] values, bool[] missingMask)->TableColumn

Parameters: name: string, values: bool[], missingMask: bool[]


Public signature
export function column(string name, string unitLabel, double[] values, bool[] missingMask)->NumericColumn

Parameters: name: string, unitLabel: string, values: double[], missingMask: bool[]


Public signature
export record ColumnarSerialization(public string schema, public int version, public string checksum, public string payload, public int rows, public int columns)

Parameters: schema: string, version: int, checksum: string, payload: string, rows: int, columns: int


Public signature
export record CsvData(public string[] headers, public string[][] rows)

Parameters: headers: string[], rows: string[][]


Public signature
export function fillLinear(NumericColumn source)->NumericColumn

Parameters: source: NumericColumn


Public signature
export record GroupedNumeric(public string[] keys, public int[] counts, public double[] sums)

Parameters: keys: string[], counts: int[], sums: double[]


Public signature
export function groupTextSum(TypedTable source, string keyName, string valueName)->GroupedNumeric

Parameters: source: TypedTable, keyName: string, valueName: string


Public signature
export function innerJoin(TypedTable left, TypedTable right, string leftKeyName, string rightKeyName, string rightPrefix)->TypedTable

Parameters: left: TypedTable, right: TypedTable, leftKeyName: string, rightKeyName: string, rightPrefix: string


Public signature
export function integerColumn(string name, long[] values, bool[] missingMask)->TableColumn

Parameters: name: string, values: long[], missingMask: bool[]


Public signature
export function numberColumn(string name, string unitLabel, double[] values, bool[] missingMask)->TableColumn

Parameters: name: string, unitLabel: string, values: double[], missingMask: bool[]


Public signature
export record NumericColumn(public string name, public string unitLabel, public double[] values, public bool[] missingMask)

Parameters: name: string, unitLabel: string, values: double[], missingMask: bool[]


Public signature
export record NumericSummary(public int present, public int missingCount, public double minimum, public double maximum, public double mean)

Parameters: present: int, missingCount: int, minimum: double, maximum: double, mean: double


Public signature
export function parseCsv(string text)->CsvData

Parameters: text: string


Public signature
export function parseTypedCsv(string identity, string text, string[] kinds, string[] units, string missingToken)->TypedTable

Parameters: identity: string, text: string, kinds: string[], units: string[], missingToken: string


Public signature
export record ScientificTable(public string identity, public int rows, public NumericColumn[] columns)

Parameters: identity: string, rows: int, columns: NumericColumn[]


Public signature
export function selectRows(ScientificTable source, bool[] keep)->ScientificTable

Parameters: source: ScientificTable, keep: bool[]


Public signature
export function selectTypedRows(TypedTable source, bool[] keep)->TypedTable

Parameters: source: TypedTable, keep: bool[]


Public signature
export function serializeColumnar(TypedTable source, int version)->ColumnarSerialization

Parameters: source: TypedTable, version: int


Public signature
export function serializeCsv(TypedTable source)->string

Parameters: source: TypedTable


Public signature
export function sortTypedRows(TypedTable source, string columnName, bool ascending)->TypedTable

Parameters: source: TypedTable, columnName: string, ascending: bool


Public signature
export function startStream()->StreamAccumulator

Public signature
export record StreamAccumulator(public int count, public double sum, public double compensation, public double minimum, public double maximum)

Parameters: count: int, sum: double, compensation: double, minimum: double, maximum: double


Public signature
export function streamingGroupBy(TypedTable[] chunks, string keyName, string valueName, int memoryBudgetGroups)->GroupedNumeric

Parameters: chunks: TypedTable[], keyName: string, valueName: string, memoryBudgetGroups: int


Public signature
export function streamingJoin(TypedTable[] leftChunks, TypedTable[] rightChunks, string leftKeyName, string rightKeyName, string rightPrefix, int memoryBudgetRows, bool ascending)->TypedTable

Parameters: leftChunks: TypedTable[], rightChunks: TypedTable[], leftKeyName: string, rightKeyName: string, rightPrefix: string, memoryBudgetRows: int, ascending: bool


Public signature
export function streamMean(StreamAccumulator state)->double

Parameters: state: StreamAccumulator


Public signature
export function summarize(NumericColumn column)->NumericSummary

Parameters: column: NumericColumn


Tables.table

function
Public signature
export function table(string identity, NumericColumn[] columns)->ScientificTable

Parameters: identity: string, columns: NumericColumn[]


Public signature
export record TableColumn(public string name, public string kind, public string unitLabel, public double[] numericValues, public long[] integerValues, public string[] textValues, public bool[] booleanValues, public bool[] missingMask)

Parameters: name: string, kind: string, unitLabel: string, numericValues: double[], integerValues: long[], textValues: string[], booleanValues: bool[], missingMask: bool[]


Public signature
export record TableSchemaValidation(public bool compatible, public int missingValues, public int duplicateColumns, public string diagnostic)

Parameters: compatible: bool, missingValues: int, duplicateColumns: int, diagnostic: string


Public signature
export function textColumn(string name, string[] values, bool[] missingMask)->TableColumn

Parameters: name: string, values: string[], missingMask: bool[]


Public signature
export function timeSeries(string identity, double[] time, double[] values, bool[] missingMask, string timeUnit, string valueUnit)->TimeSeries

Parameters: identity: string, time: double[], values: double[], missingMask: bool[], timeUnit: string, valueUnit: string


Public signature
export record TimeSeries(public string identity, public double[] time, public double[] values, public bool[] missingMask, public string timeUnit, public string valueUnit)

Parameters: identity: string, time: double[], values: double[], missingMask: bool[], timeUnit: string, valueUnit: string


Public signature
export function typedColumn(TypedTable source, string name)->TableColumn

Parameters: source: TypedTable, name: string


Public signature
export function typedColumnIndex(TypedTable source, string name)->int

Parameters: source: TypedTable, name: string


Public signature
export function typedTable(string identity, TableColumn[] columns)->TypedTable

Parameters: identity: string, columns: TableColumn[]


Public signature
export record TypedTable(public string identity, public int rows, public TableColumn[] columns)

Parameters: identity: string, rows: int, columns: TableColumn[]


Public signature
export function validateTableSchema(TypedTable source, string[] expectedNames, string[] expectedKinds, string[] expectedUnits, string missingPolicy)->TableSchemaValidation

Parameters: source: TypedTable, expectedNames: string[], expectedKinds: string[], expectedUnits: string[], missingPolicy: string


Documentation version

Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.