Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Interfaces

Type aliases

Variables

Type aliases

Binary

Binary: (v1: any, v2: any) => any

Callback invoked for each pair of indexed strided array elements retrieved via a callback function.

param

strided array element

param

strided array element

returns

result

Type declaration

    • (v1: any, v2: any): any

    • Parameters

      • v1: any
      • v2: any

      Returns any

BinaryCallback

BinaryCallback: (vx: any, vy: any) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

returns

accessed value

Type declaration

Callback

Callback: NullaryCallback | UnaryCallback | BinaryCallback | TernaryCallback | QuaternaryCallback | QuinaryCallback | SenaryCallback | SeptenaryCallback | OctonaryCallback | NovenaryCallback

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

strided index (offsetZ + idx*strideZ)

param

input array

param

input array

param

output array

returns

accessed value

NovenaryCallback

NovenaryCallback: (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number, x: Collection, y: Collection, z: Collection) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

strided index (offsetZ + idx*strideZ)

param

input array

param

input array

param

output array

returns

accessed value

Type declaration

NullaryCallback

NullaryCallback: () => ArrayLike<any>

Returns an accessed value.

returns

accessed value

Type declaration

OctonaryCallback

OctonaryCallback: (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number, x: Collection, y: Collection) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

strided index (offsetZ + idx*strideZ)

param

input array

param

input array

returns

accessed value

Type declaration

QuaternaryCallback

QuaternaryCallback: (vx: any, vy: any, idx: number, ix: number) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

returns

accessed value

Type declaration

    • (vx: any, vy: any, idx: number, ix: number): ArrayLike<any>

    • Parameters

      • vx: any
      • vy: any
      • idx: number
      • ix: number

      Returns ArrayLike < any >

QuinaryCallback

QuinaryCallback: (vx: any, vy: any, idx: number, ix: number, iy: number) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

returns

accessed value

Type declaration

    • (vx: any, vy: any, idx: number, ix: number, iy: number): ArrayLike<any>

    • Parameters

      • vx: any
      • vy: any
      • idx: number
      • ix: number
      • iy: number

      Returns ArrayLike < any >

SenaryCallback

SenaryCallback: (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

strided index (offsetZ + idx*strideZ)

returns

accessed value

Type declaration

    • (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number): ArrayLike<any>

    • Parameters

      • vx: any
      • vy: any
      • idx: number
      • ix: number
      • iy: number
      • iz: number

      Returns ArrayLike < any >

SeptenaryCallback

SeptenaryCallback: (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number, x: Collection) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

param

strided index (offsetX + idx*strideX)

param

strided index (offsetY + idx*strideY)

param

strided index (offsetZ + idx*strideZ)

param

input array

returns

accessed value

Type declaration

    • (vx: any, vy: any, idx: number, ix: number, iy: number, iz: number, x: Collection): ArrayLike<any>

    • Parameters

      • vx: any
      • vy: any
      • idx: number
      • ix: number
      • iy: number
      • iz: number
      • x: Collection

      Returns ArrayLike < any >

TernaryCallback

TernaryCallback: (vx: any, vy: any, idx: number) => ArrayLike<any>

Returns an accessed value.

param

array element

param

array element

param

iteration index

returns

accessed value

Type declaration

    • (vx: any, vy: any, idx: number): ArrayLike<any>

    • Parameters

      • vx: any
      • vy: any
      • idx: number

      Returns ArrayLike < any >

UnaryCallback

UnaryCallback: (vx: any) => ArrayLike<any>

Returns an accessed value.

param

array element

returns

accessed value

Type declaration

Variables

Export assignment mapBy2

mapBy2: Routine

Applies a binary function to each pair of elements retrieved from strided input arrays 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

input array

param

y stride length

param

destination array

param

z stride length

param

binary function to apply to callback return values

param

callback function which returns an array-like object containing two values

param

callback execution context

returns

z