@rimbu/table
Version:
Immutable spreadsheet-like data structures containing row keys, column keys, and cell values
64 lines (63 loc) • 3.59 kB
text/typescript
import { HashMap } from '@rimbu/hashed/map';
import { SortedMap } from '@rimbu/sorted/map';
import type { Streamable } from '@rimbu/stream';
import { type SortedTableHashColumnCreators, type TableBase } from '@rimbu/table/custom';
/**
* A type-invariant immutable Table of row key type R, column key type C, and value type V.
* In the Table, a combination of a row and column key has exactly one value.
* See the [Table documentation](https://rimbu.org/docs/collections/table) and the [SortedTableHashColumn API documentation](https://rimbu.org/api/rimbu/table/sorted-row/SortedTableHashColumn/interface)
* @note
* - The SortedTableHashColumn uses a SortedMap to map row keys to column.
* - The SortedTableHashColumn uses HashMaps to map column keys to values.
* @typeparam R - the row key type
* @typeparam C - the column key type
* @typeparam V - the value type
* @example
* ```ts
* const t1 = SortedTableHashColumn.empty<number, string, boolean>()
* const t2 = SortedTableHashColumn.of([1, 'a', true], [2, 'a', false])
* ```
*/
export interface SortedTableHashColumn<R, C, V> extends TableBase<R, C, V, SortedTableHashColumn.Types> {
}
export declare namespace SortedTableHashColumn {
/**
* A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V.
* In the Table, a combination of a row and column key has exactly one value.
* @note
* - The SortedTableHashColumn uses a SortedMap to map row keys to column.
* - The SortedTableHashColumn uses HashMaps to map column keys to values.
* See the [Table documentation](https://rimbu.org/docs/collections/table) and the [SortedTableHashColumn API documentation](https://rimbu.org/api/rimbu/table/sorted-row/SortedTableHashColumn/interface)
* @typeparam R - the row key type
* @typeparam C - the column key type
* @typeparam V - the value type
* @example
* ```ts
* const t1 = SortedTableHashColumn.empty<number, string, boolean>()
* const t2 = SortedTableHashColumn.of([1, 'a', true], [2, 'a', false])
* ```
*/
interface NonEmpty<R, C, V> extends TableBase.NonEmpty<R, C, V, SortedTableHashColumn.Types>, Omit<SortedTableHashColumn<R, C, V>, keyof TableBase.NonEmpty<any, any, any, any>>, Streamable.NonEmpty<[R, C, V]> {
}
interface Context<UR, UC> extends TableBase.Context<UR, UC, SortedTableHashColumn.Types> {
readonly typeTag: 'SortedTableHashColumn';
}
interface Builder<R, C, V> extends TableBase.Builder<R, C, V, SortedTableHashColumn.Types> {
}
/**
* Utility interface that provides higher-kinded types for this collection.
*/
interface Types extends TableBase.Types {
readonly normal: SortedTableHashColumn<this['_R'], this['_C'], this['_V']>;
readonly nonEmpty: SortedTableHashColumn.NonEmpty<this['_R'], this['_C'], this['_V']>;
readonly row: HashMap<this['_C'], this['_V']>;
readonly rowNonEmpty: HashMap.NonEmpty<this['_C'], this['_V']>;
readonly rowMap: SortedMap<this['_R'], HashMap.NonEmpty<this['_C'], this['_V']>>;
readonly rowMapNonEmpty: SortedMap.NonEmpty<this['_R'], HashMap.NonEmpty<this['_C'], this['_V']>>;
readonly context: SortedTableHashColumn.Context<this['_R'], this['_C']>;
readonly builder: SortedTableHashColumn.Builder<this['_R'], this['_C'], this['_V']>;
readonly rowContext: SortedMap.Context<this['_R']>;
readonly columnContext: HashMap.Context<this['_C']>;
}
}
export declare const SortedTableHashColumn: SortedTableHashColumnCreators;