SS.Collections 1.1.0
Collections owned generic list, stable-index linked-list, stack, queue, deque, insertion-ordered set/map, checked missing-key/node diagnostics, and nested-matrix APIs
Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0
No package dependencies declared.
Public API
Collections.Deque
export class Deque<T>(public T[] values)Parameters: values: T[]
Collections.Deque_count
export function Deque_count<T>(Deque<T> self) -> intParameters: self: Deque<T>
Collections.Deque_peekBack
export function Deque_peekBack<T>(Deque<T> self) -> TParameters: self: Deque<T>
Collections.Deque_peekFront
export function Deque_peekFront<T>(Deque<T> self) -> TParameters: self: Deque<T>
Collections.Deque_popBack
export function Deque_popBack<T>(Deque<T> self) -> TParameters: self: Deque<T>
Collections.Deque_popFront
export function Deque_popFront<T>(Deque<T> self) -> TParameters: self: Deque<T>
Collections.Deque_pushBack
export function Deque_pushBack<T>(Deque<T> self, T value)Parameters: self: Deque<T>, value: T
Collections.Deque_pushFront
export function Deque_pushFront<T>(Deque<T> self, T value)Parameters: self: Deque<T>, value: T
Collections.dequeFrom
export function dequeFrom<T>(T[] values) -> Deque<T>Parameters: values: T[]
Collections.dequeOf
export function dequeOf<T>(T first) -> Deque<T>Parameters: first: T
Collections.dequePopBack
export function dequePopBack<T>(T[] values) -> TParameters: values: T[]
Collections.dequePopFront
export function dequePopFront<T>(T[] values) -> TParameters: values: T[]
Collections.dequePushBack
export function dequePushBack<T>(T[] values, T value)Parameters: values: T[], value: T
Collections.dequePushFront
export function dequePushFront<T>(T[] values, T value)Parameters: values: T[], value: T
Collections.dictionaryGet
export function dictionaryGet<K, V>(K[] keys, V[] values, K key) -> VParameters: keys: K[], values: V[], key: K
Collections.dictionaryIndex
export function dictionaryIndex<K>(K[] keys, K key) -> intParameters: keys: K[], key: K
Collections.dictionarySet
export function dictionarySet<K, V>(K[] keys, V[] values, K key, V value)Parameters: keys: K[], values: V[], key: K, value: V
export class DoublyLinkedList<T>(public T[] values, public int[] next, public int[] previous, public mutable int head, public mutable int tail, public mutable int count)Parameters: values: T[], next: int[], previous: int[], head: mutable int, tail: mutable int, count: mutable int
export function DoublyLinkedList_append<T>(DoublyLinkedList<T> self, T value)Parameters: self: DoublyLinkedList<T>, value: T
export function DoublyLinkedList_nextNode<T>(DoublyLinkedList<T> self, int node) -> intParameters: self: DoublyLinkedList<T>, node: int
export function DoublyLinkedList_previousNode<T>(DoublyLinkedList<T> self, int node) -> intParameters: self: DoublyLinkedList<T>, node: int
export function DoublyLinkedList_remove<T>(DoublyLinkedList<T> self, int node) -> TParameters: self: DoublyLinkedList<T>, node: int
export function DoublyLinkedList_value<T>(DoublyLinkedList<T> self, int node) -> TParameters: self: DoublyLinkedList<T>, node: int
Collections.doublyLinkedListFrom
export function doublyLinkedListFrom<T>(T[] values) -> DoublyLinkedList<T>Parameters: values: T[]
Collections.doublyLinkedListOf
export function doublyLinkedListOf<T>(T first) -> DoublyLinkedList<T>Parameters: first: T
Collections.list
export function list<T>(T[] values) -> T[]Parameters: values: T[]
Collections.List
export class List<T>(public T[] values)Parameters: values: T[]
Collections.List_add
export function List_add<T>(List<T> self, T value)Parameters: self: List<T>, value: T
Collections.List_contains
export function List_contains<T>(List<T> self, T value) -> boolParameters: self: List<T>, value: T
Collections.List_count
export function List_count<T>(List<T> self) -> intParameters: self: List<T>
Collections.List_get
export function List_get<T>(List<T> self, int index) -> TParameters: self: List<T>, index: int
Collections.List_insert
export function List_insert<T>(List<T> self, int index, T value)Parameters: self: List<T>, index: int, value: T
Collections.List_removeAt
export function List_removeAt<T>(List<T> self, int index) -> TParameters: self: List<T>, index: int
Collections.List_set
export function List_set<T>(List<T> self, int index, T value)Parameters: self: List<T>, index: int, value: T
Collections.listFrom
export function listFrom<T>(T[] values) -> List<T>Parameters: values: T[]
Collections.listOf
export function listOf<T>(T first) -> List<T>Parameters: first: T
Collections.Map
export class Map<K, V>(public K[] keys, public V[] values)Parameters: keys: K[], values: V[]
Collections.Map_containsKey
export function Map_containsKey<K, V>(Map<K, V> self, K key) -> boolParameters: self: Map<K,V>, key: K
Collections.Map_count
export function Map_count<K, V>(Map<K, V> self) -> intParameters: self: Map<K,V>
Collections.Map_get
export function Map_get<K, V>(Map<K, V> self, K key) -> VParameters: self: Map<K, V>, key: K
Collections.Map_remove
export function Map_remove<K, V>(Map<K, V> self, K key) -> boolParameters: self: Map<K, V>, key: K
Collections.Map_set
export function Map_set<K, V>(Map<K, V> self, K key, V value)Parameters: self: Map<K, V>, key: K, value: V
Collections.mapFrom
export function mapFrom<K, V>(K[] keys, V[] values) -> Map<K, V>Parameters: keys: K[], values: V[]
Collections.mapOf
export function mapOf<K, V>(K key, V value) -> Map<K, V>Parameters: key: K, value: V
Collections.matrixGet
export function matrixGet<T>(T[][] values, int row, int column) -> TParameters: values: T[][], row: int, column: int
Collections.matrixSet
export function matrixSet<T>(T[][] values, int row, int column, T value)Parameters: values: T[][], row: int, column: int, value: T
Collections.Queue
export class Queue<T>(public T[] values)Parameters: values: T[]
Collections.Queue_count
export function Queue_count<T>(Queue<T> self) -> intParameters: self: Queue<T>
Collections.Queue_dequeue
export function Queue_dequeue<T>(Queue<T> self) -> TParameters: self: Queue<T>
Collections.Queue_enqueue
export function Queue_enqueue<T>(Queue<T> self, T value)Parameters: self: Queue<T>, value: T
Collections.Queue_peek
export function Queue_peek<T>(Queue<T> self) -> TParameters: self: Queue<T>
Collections.queueDequeue
export function queueDequeue<T>(T[] values) -> TParameters: values: T[]
Collections.queueEnqueue
export function queueEnqueue<T>(T[] values, T value)Parameters: values: T[], value: T
Collections.queueFrom
export function queueFrom<T>(T[] values) -> Queue<T>Parameters: values: T[]
Collections.queueOf
export function queueOf<T>(T first) -> Queue<T>Parameters: first: T
Collections.Set
export class Set<T>(public T[] values)Parameters: values: T[]
Collections.Set_add
export function Set_add<T>(Set<T> self, T value) -> boolParameters: self: Set<T>, value: T
Collections.Set_contains
export function Set_contains<T>(Set<T> self, T value) -> boolParameters: self: Set<T>, value: T
Collections.Set_count
export function Set_count<T>(Set<T> self) -> intParameters: self: Set<T>
Collections.Set_remove
export function Set_remove<T>(Set<T> self, T value) -> boolParameters: self: Set<T>, value: T
Collections.setAdd
export function setAdd<T>(T[] values, T value) -> boolParameters: values: T[], value: T
Collections.setFrom
export function setFrom<T>(T[] values) -> Set<T>Parameters: values: T[]
Collections.setOf
export function setOf<T>(T first) -> Set<T>Parameters: first: T
export class SinglyLinkedList<T>(public T[] values, public int[] next, public mutable int head, public mutable int tail, public mutable int count)Parameters: values: T[], next: int[], head: mutable int, tail: mutable int, count: mutable int
export function SinglyLinkedList_append<T>(SinglyLinkedList<T> self, T value)Parameters: self: SinglyLinkedList<T>, value: T
export function SinglyLinkedList_nextNode<T>(SinglyLinkedList<T> self, int node) -> intParameters: self: SinglyLinkedList<T>, node: int
export function SinglyLinkedList_removeAfter<T>(SinglyLinkedList<T> self, int node) -> TParameters: self: SinglyLinkedList<T>, node: int
export function SinglyLinkedList_removeFirst<T>(SinglyLinkedList<T> self) -> TParameters: self: SinglyLinkedList<T>
export function SinglyLinkedList_value<T>(SinglyLinkedList<T> self, int node) -> TParameters: self: SinglyLinkedList<T>, node: int
Collections.singlyLinkedListFrom
export function singlyLinkedListFrom<T>(T[] values) -> SinglyLinkedList<T>Parameters: values: T[]
Collections.singlyLinkedListOf
export function singlyLinkedListOf<T>(T first) -> SinglyLinkedList<T>Parameters: first: T
Collections.Stack
export class Stack<T>(public T[] values)Parameters: values: T[]
Collections.Stack_count
export function Stack_count<T>(Stack<T> self) -> intParameters: self: Stack<T>
Collections.Stack_peek
export function Stack_peek<T>(Stack<T> self) -> TParameters: self: Stack<T>
Collections.Stack_pop
export function Stack_pop<T>(Stack<T> self) -> TParameters: self: Stack<T>
Collections.Stack_push
export function Stack_push<T>(Stack<T> self, T value)Parameters: self: Stack<T>, value: T
Collections.stackFrom
export function stackFrom<T>(T[] values) -> Stack<T>Parameters: values: T[]
Collections.stackOf
export function stackOf<T>(T first) -> Stack<T>Parameters: first: T
Collections.stackPeek
export function stackPeek<T>(T[] values) -> TParameters: values: T[]
Collections.stackPop
export function stackPop<T>(T[] values) -> TParameters: values: T[]
Collections.stackPush
export function stackPush<T>(T[] values, T value)Parameters: values: T[], value: T
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.