SortedSet | typescript-super-set

SortedSetInterface

Ordered set (order by comparator result ASC/DESC)

Type parameters

T

Hierarchy

AbstractSuperSet<T>
- SortedSet
  - SortedSetObs

Implements

SetInterface<T>
Iterable<T>
SortedSet<T>

Implemented by

Index

Constructors

constructor

Properties

Accessors

elements

Constructors

constructor

new SortedSet(comparator: Comparator<T>, sort: ORDER, ...elements: T[]): SortedSet

Overrides AbstractSuperSet.constructor
- Defined in src/core/sortedSet.ts:66
constructor

Parameters
- comparator: Comparator<T>
- sort: ORDER
- Rest ...elements: T[]
Returns SortedSet

Properties

Private _comparator

_comparator: Comparator<T>

_comparator

param
param

Protected _elements

_elements: T[] = []

_elements

Protected sort

sort: ORDER

sort

Static Readonly ACTION_ADD

ACTION_ADD: "ACTION_ADD" = "ACTION_ADD"

Types of actions

Static Readonly ACTION_CLEAR

ACTION_CLEAR: "ACTION_CLEAR" = "ACTION_CLEAR"

Static Readonly ACTION_DELETE

ACTION_DELETE: "ACTION_DELETE" = "ACTION_DELETE"

Static Readonly ACTION_REPLACE

ACTION_REPLACE: "ACTION_REPLACE" = "ACTION_REPLACE"

Accessors

elements

get elements(): T[]
set elements(elements: T[]): void

Inherited from AbstractSuperSet.elements
- Defined in src/core/abstractSuperSet.ts:231
get elements

Returns T[]
Inherited from AbstractSuperSet.elements
- Defined in src/core/abstractSuperSet.ts:240
set elements

Parameters
- elements: T[]
Returns void

Methods

[Symbol.iterator]

[Symbol.iterator](): any

Inherited from AbstractSuperSet.[Symbol.iterator]
- Defined in src/core/abstractSuperSet.ts:14
Iterator

Returns any

Protected actionAdd

actionAdd(elements: T[]): void

Inherited from AbstractSuperSet.actionAdd
- Defined in src/core/abstractSuperSet.ts:73
actionAdd

ACTION_ADD element

Parameters
- elements: T[]
Returns void

Protected actionClear

actionClear(): this

Inherited from AbstractSuperSet.actionClear
- Defined in src/core/abstractSuperSet.ts:105
clear

ACTION_CLEAR set

Returns this

Protected actionDelete

actionDelete(elements: T[]): void

Inherited from AbstractSuperSet.actionDelete
- Defined in src/core/abstractSuperSet.ts:90
actionDelete

ACTION_DELETE element

Parameters
- elements: T[]
Returns void

add

add(...element: T[]): this

Implementation of SetInterface.add

Inherited from AbstractSuperSet.add
- Defined in src/core/abstractSuperSet.ts:172
add

Parameters
- Rest ...element: T[]
Returns this

Protected afterAction

afterAction(fName: string, elements: T | T[]): void

Overrides AbstractSuperSet.afterAction
- Defined in src/core/sortedSet.ts:41
afterAction hook

Sort Set using declared order/comparator

Parameters
- fName: string
- elements: T | T[]
Returns void

Protected beforeAction

beforeAction(fName: string, elements: T | T[]): void

Overrides AbstractSuperSet.beforeAction
- Defined in src/core/sortedSet.ts:51
beforeAction hook

Parameters
- fName: string
- elements: T | T[]
Returns void

clear

clear(): this

Implementation of SetInterface.clear

Inherited from AbstractSuperSet.clear
- Defined in src/core/abstractSuperSet.ts:180
clear

Returns this

delete

delete(...elements: T[]): this

Implementation of SetInterface.delete

Inherited from AbstractSuperSet.delete
- Defined in src/core/abstractSuperSet.ts:189
add

Parameters
- Rest ...elements: T[]
Returns this

has

has(element: T): boolean

Implementation of SetInterface.has

Inherited from AbstractSuperSet.has
- Defined in src/core/abstractSuperSet.ts:199
has

Parameters
- element: T
Returns boolean

hasAll

hasAll(...element: T[]): boolean

Implementation of SetInterface.hasAll

Inherited from AbstractSuperSet.hasAll
- Defined in src/core/abstractSuperSet.ts:217
hasAll

Parameters
- Rest ...element: T[]
Returns boolean

hasNot

hasNot(element: T): boolean

Implementation of SetInterface.hasNot

Inherited from AbstractSuperSet.hasNot
- Defined in src/core/abstractSuperSet.ts:208
hasNot

Parameters
- element: T
Returns boolean

Protected isUnique

isUnique(element: T): boolean

Inherited from AbstractSuperSet.isUnique
- Defined in src/core/abstractSuperSet.ts:140
isUnique

Parameters
- element: T
Returns boolean

refresh

refresh(): void

Implementation of SetInterface.refresh

Inherited from AbstractSuperSet.refresh
- Defined in src/core/abstractSuperSet.ts:165
refresh

Returns void

Protected replaceAndPreventHook

replaceAndPreventHook(elements: T[]): void

Inherited from AbstractSuperSet.replaceAndPreventHook
- Defined in src/core/abstractSuperSet.ts:117
replaceAndPreventHook

Parameters
- elements: T[]
Returns void

Protected replaceWithHook

replaceWithHook(elements: T[]): void

Inherited from AbstractSuperSet.replaceWithHook
- Defined in src/core/abstractSuperSet.ts:129
replaceWithHook

Parameters
- elements: T[]
Returns void

reverseOrder

reverseOrder(): void

- Defined in src/core/sortedSet.ts:28
reverseOrder

Returns void

setSort

setSort(sort: ORDER): void

- Defined in src/core/sortedSet.ts:20
setSort

Parameters
- sort: ORDER
Returns void

size

size(): number

Implementation of SetInterface.size

Inherited from AbstractSuperSet.size
- Defined in src/core/abstractSuperSet.ts:224
size

Returns number

Protected sortSet

sortSet(): void

- Defined in src/core/sortedSet.ts:56
sortSet

Returns void

toString

toString(): string

Inherited from AbstractSuperSet.toString
- Defined in src/core/abstractSuperSet.ts:62
toString

Returns string

Static isHashableNumType

isHashableNumType(value: any): value is HashableReturnNum

Inherited from AbstractSuperSet.isHashableNumType
- Defined in src/core/abstractSuperSet.ts:158
isHashableNumType

Parameters
- value: any
Returns value is HashableReturnNum

Static isHashableStrType

isHashableStrType(value: any): value is HashableReturnStr

Inherited from AbstractSuperSet.isHashableStrType
- Defined in src/core/abstractSuperSet.ts:149
isHashableStrType

Parameters
- value: any
Returns value is HashableReturnStr

Generated using TypeDoc