Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "strided/base/map-by/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

BinaryCallback

BinaryCallback: (value: any, idx: number) => any

Returns an accessed value.

param

array element

param

iteration index

returns

accessed value

Type declaration

    • (value: any, idx: number): any

    • Parameters

      • value: any
      • idx: number

      Returns any

Callback

Callback: NullaryCallback | UnaryCallback | BinaryCallback | TernaryCallback | QuaternaryCallback | QuinaryCallback | SenaryCallback

Returns an accessed value.

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

input array

param

output array

returns

accessed value

NullaryCallback

NullaryCallback: () => any

Returns an accessed value.

returns

accessed value

Type declaration

    • (): any

    • Returns any

QuaternaryCallback

QuaternaryCallback: (value: any, idx: number, ix: number, iy: number) => any

Returns an accessed value.

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

returns

accessed value

Type declaration

    • (value: any, idx: number, ix: number, iy: number): any

    • Parameters

      • value: any
      • idx: number
      • ix: number
      • iy: number

      Returns any

QuinaryCallback

QuinaryCallback: (value: any, idx: number, ix: number, iy: number, x: Collection) => any

Returns an accessed value.

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

input array

returns

accessed value

Type declaration

    • (value: any, idx: number, ix: number, iy: number, x: Collection): any

    • Parameters

      • value: any
      • idx: number
      • ix: number
      • iy: number
      • x: Collection

      Returns any

SenaryCallback

SenaryCallback: (value: any, idx: number, ix: number, iy: number, x: Collection, y: Collection) => any

Returns an accessed value.

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

input array

param

output array

returns

accessed value

Type declaration

TernaryCallback

TernaryCallback: (value: any, idx: number, ix: number) => any

Returns an accessed value.

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

returns

accessed value

Type declaration

    • (value: any, idx: number, ix: number): any

    • Parameters

      • value: any
      • idx: number
      • ix: number

      Returns any

Unary

Unary: (value: any) => any

Callback invoked for each indexed strided array element retrieved via a callback function.

param

strided array element

returns

result

Type declaration

    • (value: any): any

    • Parameters

      • value: any

      Returns any

UnaryCallback

UnaryCallback: (value: any) => any

Returns an accessed value.

param

array element

returns

accessed value

Type declaration

    • (value: any): any

    • Parameters

      • value: any

      Returns any

Variables

Export assignment mapBy

mapBy: Routine

Applies a unary function to each element retrieved from a strided input array according to a callback function and assigns results to a strided output array.

param

number of indexed elements

param

input array

param

x stride length

param

destination array

param

y stride length

param

unary function to apply to callback return values

param

callback function

param

callback execution context

returns

y