MappableGenerator | Physics Math

Type parameters

T
TReturn
TNext

Hierarchy

MappableGenerator

Implements

Generator<T, TReturn, TNext>
Iterable<T>

Index

Properties

returning

Methods

Properties

Optional returning

returning: any

Methods

Abstract [Symbol.iterator]

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

- Defined in src/utils.ts:40
Returns Generator<T>

asArray

asArray(): T[]

- Defined in src/utils.ts:46
Returns T[]

concat

concat(...gens: Genable<T>[]): MappableGenerator<T, any, unknown>

- Defined in src/utils.ts:280
Concatenates generators (or iterators or iterables).

Ensures that any supplied generators are terminated when this is terminated.

Parameters
- Rest ...gens: Genable<T>[]
  
  zero or more additional [Genable] to provide values.
Returns MappableGenerator<T, any, unknown>

every

every(p: (v: T, idx: number) => boolean, thisArg?: any): boolean

- Defined in src/utils.ts:354
Parameters
- p: (v: T, idx: number) => boolean
  - - (v: T, idx: number): boolean
    - Parameters
      - v: T
      - idx: number
      Returns boolean
- Optional thisArg: any
Returns boolean

filter

filter(p: (v: T) => boolean, thisArg?: any): MappableGenerator<T, TReturn, TNext>

- Defined in src/utils.ts:100
Parameters
- p: (v: T) => boolean
  - - (v: T): boolean
    - Parameters
      - v: T
      Returns boolean
- Optional thisArg: any
Returns MappableGenerator<T, TReturn, TNext>

flat

flat<D>(depth?: D): MappableGenerator<FlatGen<T, D>>

- Defined in src/utils.ts:143
Type parameters
- D: number
Parameters
- Default value depth: D = 1 as D
Returns MappableGenerator<FlatGen<T, D>>

flatMap

flatMap<D, R>(f: (v: T, idx: number) => R, depth?: D): MappableGenerator<R>

- Defined in src/utils.ts:185
Type parameters
- D: number
- R
Parameters
- f: (v: T, idx: number) => R
  - - (v: T, idx: number): R
    - Parameters
      - v: T
      - idx: number
      Returns R
- Default value depth: D = 1 as D
Returns MappableGenerator<R>

forEach

forEach(f: (v: T) => void, thisArg?: any): any

- Defined in src/utils.ts:50
Parameters
- f: (v: T) => void
  - - (v: T): void
    - Parameters
      - v: T
      Returns void
- Optional thisArg: any
Returns any

join

join(sep?: undefined | string): string

- Defined in src/utils.ts:366
Trivial, but handy, same as Array.prototype.join.

Parameters
- Optional sep: undefined | string
Returns string

map

map<V>(f: (v: T) => V, thisArg?: any): MappableGenerator<V>

- Defined in src/utils.ts:58
Type parameters
- V
Parameters
- f: (v: T) => V
  - - (v: T): V
    - Parameters
      - v: T
      Returns V
- Optional thisArg: any
Returns MappableGenerator<V>

Abstract next

next(): IteratorResult<T>

- Defined in src/utils.ts:38
Returns IteratorResult<T>

reduce

reduce<A>(f: (acc: A | T, v: T) => A): A
reduce<A>(f: (acc: A, v: T) => A, init: A): A

- Defined in src/utils.ts:315
Like Array.prototype.reduce, but the 3rd argument to the reducing function ("array") is omitted because there is no array.

Type parameters
- A
Parameters
- f: (acc: A | T, v: T) => A
  - - (acc: A | T, v: T): A
    - Parameters
      - acc: A | T
      - v: T
      Returns A
Returns A
- Defined in src/utils.ts:322
Like Array.prototype.reduce, but the 3rd argument to the reducing function ("array") is omitted because there is no array.

Type parameters
- A
Parameters
- f: (acc: A, v: T) => A
  - - (acc: A, v: T): A
    - Parameters
      - acc: A
      - v: T
      Returns A
- init: A
Returns A

Abstract return

return(value: any): IteratorResult<T>

- Defined in src/utils.ts:42
Parameters
- value: any
Returns IteratorResult<T>

slice

slice(start?: number, end?: number): MappableGenerator<T>

- Defined in src/utils.ts:232
Parameters
- Default value start: number = 0
- Default value end: number = Number.POSITIVE_INFINITY
Returns MappableGenerator<T>

some

some(p: (v: T, idx: number) => boolean, thisArg?: any): boolean

- Defined in src/utils.ts:346
Parameters
- p: (v: T, idx: number) => boolean
  - - (v: T, idx: number): boolean
    - Parameters
      - v: T
      - idx: number
      Returns boolean
- Optional thisArg: any
Returns boolean

Abstract throw

throw(e: any): IteratorResult<T>

- Defined in src/utils.ts:44
Parameters
- e: any
Returns IteratorResult<T>

Static concat

concat<T>(...gens: Genable<T>[]): MappableGenerator<T>

- Defined in src/utils.ts:290
Concatenates generators (or iterators or iterables).

Ensures that any supplied generators are terminated when this is terminated.

Type parameters
- T
Parameters
- Rest ...gens: Genable<T>[]
  
  zero or more additional [Genable] to provide values.
Returns MappableGenerator<T>

Static every

every<T>(gen: Genable<T>, p: (v: T, idx: number) => boolean, thisArg?: any): boolean

- Defined in src/utils.ts:358
Type parameters
- T
Parameters
- gen: Genable<T>
- p: (v: T, idx: number) => boolean
  - - (v: T, idx: number): boolean
    - Parameters
      - v: T
      - idx: number
      Returns boolean
- Optional thisArg: any
Returns boolean

Static extend

extend<T, R, N>(gen: Genable<T>): MappableGenerator<T, R, N>

- Defined in src/utils.ts:369
Type parameters
- T
- R
- N
Parameters
- gen: Genable<T>
Returns MappableGenerator<T, R, N>

Static filter

filter<T>(f: (v: T) => boolean, thisArg?: any): (iter: Genable<T>) => MappableGenerator<T>

- Defined in src/utils.ts:104
Type parameters
- T
Parameters
- f: (v: T) => boolean
  - - (v: T): boolean
    - Parameters
      - v: T
      Returns boolean
- Optional thisArg: any
Returns (iter: Genable<T>) => MappableGenerator<T>
- - (iter: Genable<T>): MappableGenerator<T>
  - Parameters
    - iter: Genable<T>
    Returns MappableGenerator<T>

Static flat

flat<T, D>(gen: Genable<T>, depth?: D): MappableGenerator<FlatGen<T, D>>

- Defined in src/utils.ts:147
Type parameters
- T
- D: number
Parameters
- gen: Genable<T>
- Default value depth: D = 1 as D
Returns MappableGenerator<FlatGen<T, D>>

Static flatMap

flatMap<T, D, R>(f: (v: T, idx: number) => R, depth?: D): (gen: Genable<any>) => MappableGenerator<R>

- Defined in src/utils.ts:189
Type parameters
- T
- D: number
- R
Parameters
- f: (v: T, idx: number) => R
  - - (v: T, idx: number): R
    - Parameters
      - v: T
      - idx: number
      Returns R
- Default value depth: D = 1 as D
Returns (gen: Genable<any>) => MappableGenerator<R>
- - (gen: Genable<any>): MappableGenerator<R>
  - Parameters
    - gen: Genable<any>
    Returns MappableGenerator<R>

Static map

map<V, T>(f: (v: T) => V, thisArg?: any): (iter: Genable<T>) => MappableGenerator<V>

- Defined in src/utils.ts:62
Type parameters
- V
- T
Parameters
- f: (v: T) => V
  - - (v: T): V
    - Parameters
      - v: T
      Returns V
- Optional thisArg: any
Returns (iter: Genable<T>) => MappableGenerator<V>
- - (iter: Genable<T>): MappableGenerator<V>
  - Parameters
    - iter: Genable<T>
    Returns MappableGenerator<V>

Static reduce

reduce<T, A>(gen: Genable<T>, f: (acc: A | T, v: T) => A): A
reduce<T, A>(gen: Genable<T>, f: (acc: A, v: T) => A, init: A): A

- Defined in src/utils.ts:333
Reduces gen like Array.prototype.reduce, but the 3rd argument to the reducing function ("array") is omitted because there is no array.

Type parameters
- T
- A
Parameters
- gen: Genable<T>
- f: (acc: A | T, v: T) => A
  - - (acc: A | T, v: T): A
    - Parameters
      - acc: A | T
      - v: T
      Returns A
Returns A
- Defined in src/utils.ts:341
Reduces gen like Array.prototype.reduce, but the 3rd argument to the reducing function ("array") is omitted because there is no array.

Type parameters
- T
- A
Parameters
- gen: Genable<T>
- f: (acc: A, v: T) => A
  - - (acc: A, v: T): A
    - Parameters
      - acc: A
      - v: T
      Returns A
- init: A
Returns A

Static slice

slice<T>(iter: Genable<T>, start?: number, end?: number): MappableGenerator<T>

- Defined in src/utils.ts:236
Type parameters
- T
Parameters
- iter: Genable<T>
- Default value start: number = 0
- Default value end: number = Number.POSITIVE_INFINITY
Returns MappableGenerator<T>

Static some

some<T>(gen: Genable<T>, p: (v: T, idx: number) => boolean, thisArg?: any): boolean

- Defined in src/utils.ts:350
Type parameters
- T
Parameters
- gen: Genable<T>
- p: (v: T, idx: number) => boolean
  - - (v: T, idx: number): boolean
    - Parameters
      - v: T
      - idx: number
      Returns boolean
- Optional thisArg: any
Returns boolean

Type parameters

T

TReturn

TNext

Hierarchy

Implements

Index

Properties

Methods

Properties

Optional returning

Methods

Abstract [Symbol.iterator]

Returns Generator<T>

asArray

Returns T[]

concat

Parameters

Rest ...gens: Genable<T>[]

Returns MappableGenerator<T, any, unknown>

every

Parameters

p: (v: T, idx: number) => boolean

Parameters

v: T

idx: number

Returns boolean

Optional thisArg: any

Returns boolean

filter

Parameters

p: (v: T) => boolean

Parameters

v: T

Returns boolean

Optional thisArg: any

Returns MappableGenerator<T, TReturn, TNext>

flat

Type parameters

D: number

Parameters

Default value depth: D = 1 as D

Returns MappableGenerator<FlatGen<T, D>>

flatMap

Type parameters

D: number

R

Parameters

f: (v: T, idx: number) => R

Parameters

v: T

idx: number

Returns R

Default value depth: D = 1 as D

Returns MappableGenerator<R>

forEach

Parameters

f: (v: T) => void

Parameters

v: T

Returns void

Optional thisArg: any

Returns any

join

Parameters

Optional sep: undefined | string

Returns string

map

Type parameters

V

Parameters

f: (v: T) => V

Parameters

v: T

Returns V

Optional thisArg: any

Returns MappableGenerator<V>

Abstract next

Returns IteratorResult<T>

reduce