Class DCons<T>

Type parameters

T

Hierarchy

DCons

Implements

IClear
ICompare<DCons<T>>
ICopy<DCons<T>>
IEmpty<DCons<T>>
IEquiv
ILength
IReducible<any, T>
IRelease
ISeqable<T>
IStack<T, T, DCons<T>>

Index

Constructors

constructor

Properties

Accessors

length

Constructors

constructor

new DCons(src?: Iterable<T>): DCons

- Defined in index.ts:44
Parameters
- Optional src: Iterable<T>
Returns DCons

Properties

Protected _length

_length: number = 0

head

head: ConsCell<T> | undefined

tail

tail: ConsCell<T> | undefined

Accessors

length

get length(): number

- Defined in index.ts:52
Returns number

Methods

$reduce

$reduce(rfn: ReductionFn<any, T>, acc: any): any

- Defined in index.ts:154
{@inheritDoc @thi.ng/transducers#IReducible.$reduce}
Parameters
- rfn: ReductionFn<any, T>
- acc: any
Returns any

[Symbol.iterator]

[Symbol.iterator](): Generator<T, void, unknown>

- Defined in index.ts:123
Returns Generator<T, void, unknown>

asHead

asHead(cell: ConsCell<T>): this

- Defined in index.ts:603
Parameters
- cell: ConsCell<T>
Returns this

asTail

asTail(cell: ConsCell<T>): this

- Defined in index.ts:616
Parameters
- cell: ConsCell<T>
Returns this

clear

clear(): void

- Defined in index.ts:64
Returns void

compare

compare(o: DCons<T>): number

- Defined in index.ts:84
Parameters
- o: DCons<T>
Returns number

concat

concat(...slices: Iterable<T>[]): DCons<T>

- Defined in index.ts:275
Parameters
- Rest ...slices: Iterable<T>[]
Returns DCons<T>

cons

cons(value: T): DCons<T>

- Defined in index.ts:177
Parameters
- value: T
Returns DCons<T>

copy

copy(): DCons<T>

- Defined in index.ts:56
Returns DCons<T>

cycle

cycle(): Generator<T, void, unknown>

- Defined in index.ts:147
Returns Generator<T, void, unknown>

drop

drop(): undefined | T

- Defined in index.ts:163
Returns undefined | T

empty

empty(): DCons<T>

- Defined in index.ts:60
Returns DCons<T>

Protected ensureIndex

ensureIndex(i: number): void

- Defined in index.ts:649
Parameters
- i: number
Returns void

equiv

equiv(o: any): boolean

- Defined in index.ts:105
Parameters
- o: any
Returns boolean

filter

filter(pred: Predicate<T>): DCons<T>

- Defined in index.ts:472
Parameters
- pred: Predicate<T>
Returns DCons<T>

find

find(value: T): undefined | ConsCell<T>

- Defined in index.ts:255
Parameters
- value: T
Returns undefined | ConsCell<T>

findWith

findWith(fn: Predicate<T>): undefined | ConsCell<T>

- Defined in index.ts:265
Parameters
- fn: Predicate<T>
Returns undefined | ConsCell<T>

first

first(): undefined | T

- Defined in index.ts:390
Returns undefined | T

insertAfter

insertAfter(cell: ConsCell<T>, value: T): DCons<T>

- Defined in index.ts:204
Parameters
- cell: ConsCell<T>
- value: T
Returns DCons<T>

insertAfterNth

insertAfterNth(n: number, x: T): DCons<T>

- Defined in index.ts:231
Parameters
- n: number
- x: T
Returns DCons<T>

insertBefore

insertBefore(cell: ConsCell<T>, value: T): DCons<T>

- Defined in index.ts:189
Parameters
- cell: ConsCell<T>
- value: T
Returns DCons<T>

insertBeforeNth

insertBeforeNth(n: number, x: T): DCons<T>

- Defined in index.ts:219
Parameters
- n: number
- x: T
Returns DCons<T>

insertSorted

insertSorted(value: T, cmp?: Comparator<T>): DCons<T>

- Defined in index.ts:243
Parameters
- value: T
- Optional cmp: Comparator<T>
Returns DCons<T>

into

into(src: Iterable<T>): void

- Defined in index.ts:283
Parameters
- src: Iterable<T>
Returns void

map

map<R>(fn: Fn<T, R>): DCons<R>

- Defined in index.ts:462
Type parameters
- R
Parameters
- fn: Fn<T, R>
Returns DCons<R>

nth

nth(n: number, notFound?: T): undefined | T

- Defined in index.ts:421
Parameters
- n: number
- Optional notFound: T
Returns undefined | T

nthCell

nthCell(n: number): undefined | ConsCell<T>

- Defined in index.ts:426
Parameters
- n: number
Returns undefined | ConsCell<T>

Protected nthCellUnsafe

nthCellUnsafe(n: number): ConsCell<T>

- Defined in index.ts:653
Parameters
- n: number
Returns ConsCell<T>

peek

peek(): undefined | T

- Defined in index.ts:394
Returns undefined | T

pop

pop(): undefined | T

- Defined in index.ts:375
Returns undefined | T

push

push(value: T): DCons<T>

- Defined in index.ts:363
Parameters
- value: T
Returns DCons<T>

reduce

reduce<R>(rfn: ReductionFn<R, T>, initial: R): R

- Defined in index.ts:482
Type parameters
- R
Parameters
- rfn: ReductionFn<R, T>
- initial: R
Returns R

release

release(): boolean

- Defined in index.ts:68
Returns boolean

remove

remove(cell: ConsCell<T>): this

- Defined in index.ts:339
Parameters
- cell: ConsCell<T>
Returns this

reverse

reverse(): this

- Defined in index.ts:588
Returns this

rotateLeft

rotateLeft(): DCons<T>

- Defined in index.ts:436
Returns DCons<T>

rotateRight

rotateRight(): DCons<T>

- Defined in index.ts:448
Returns DCons<T>

seq

seq(start?: number, end?: number): undefined | ISeq<T>

- Defined in index.ts:132
{@inheritDoc @thi.ng/api#ISeqable.seq}
Parameters
- Default value start: number = 0
- Default value end: number = this.length
Returns undefined | ISeq<T>

setHead

setHead(v: T): DCons<T>

- Defined in index.ts:398
Parameters
- v: T
Returns DCons<T>

setNth

setNth(n: number, v: T): this

- Defined in index.ts:414
Parameters
- n: number
- v: T
Returns this

setTail

setTail(v: T): DCons<T>

- Defined in index.ts:406
Parameters
- v: T
Returns DCons<T>

shuffle

shuffle(iter?: undefined | number, rnd?: IRandom): this

- Defined in index.ts:507
Shuffles list by probabilistically moving cells to head or tail positions.
remarks
Supports configurable iterations and custom PRNG via {@link @thi.ng/random#IRandom} (default: {@link @thi.ng/random#SYSTEM}).
Default iterations: ceil(3/2 * log2(n))
Parameters
- Optional iter: undefined | number
  -
- Default value rnd: IRandom = SYSTEM
  -
Returns this

slice

slice(from?: number, to?: number): DCons<T>

- Defined in index.ts:289
Parameters
- Default value from: number = 0
- Default value to: number = this.length
Returns DCons<T>

sort

sort(cmp?: Comparator<T>): this

- Defined in index.ts:533
Merge sort implementation based on Simon Tatham's algorithm: https://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
remarks
Uses {@link @thi.ng/compare#compare} as default comparator.
Parameters
- Default value cmp: Comparator<T> = compare
  -
Returns this

splice

splice(at: ConsCell<T> | number, del?: number, insert?: Iterable<T>): DCons<T>

- Defined in index.ts:304
Parameters
- at: ConsCell<T> | number
- Default value del: number = 0
- Optional insert: Iterable<T>
Returns DCons<T>

swap

swap(a: ConsCell<T>, b: ConsCell<T>): DCons<T>

- Defined in index.ts:354
Parameters
- a: ConsCell<T>
- b: ConsCell<T>
Returns DCons<T>

toJSON

toJSON(): T[]

- Defined in index.ts:645
Returns T[]

toString

toString(): any

- Defined in index.ts:629
Returns any

Generated using TypeDoc