Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/range-by/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

Binary

Binary: (value: any, aidx: number) => number | void

Returns an accessed value.

param

array element

param

array index

returns

accessed value

Type declaration

    • (value: any, aidx: number): number | void

    • Parameters

      • value: any
      • aidx: number

      Returns number | void

Callback

Callback: Nullary | Unary | Binary | Ternary | Quaternary

Returns an accessed value.

param

array element

param

array index

param

strided index (offset + aidx*stride)

param

input array

returns

accessed value

Nullary

Nullary: () => number | void

Returns an accessed value.

returns

accessed value

Type declaration

    • (): number | void

    • Returns number | void

Quaternary

Quaternary: (value: any, aidx: number, sidx: number, array: Collection) => number | void

Returns an accessed value.

param

array element

param

array index

param

strided index (offset + aidx*stride)

param

input array

returns

accessed value

Type declaration

    • (value: any, aidx: number, sidx: number, array: Collection): number | void

    • Parameters

      • value: any
      • aidx: number
      • sidx: number
      • array: Collection

      Returns number | void

Ternary

Ternary: (value: any, aidx: number, sidx: number) => number | void

Returns an accessed value.

param

array element

param

array index

param

strided index (offset + aidx*stride)

returns

accessed value

Type declaration

    • (value: any, aidx: number, sidx: number): number | void

    • Parameters

      • value: any
      • aidx: number
      • sidx: number

      Returns number | void

Unary

Unary: (value: any) => number | void

Returns an accessed value.

param

array element

returns

accessed value

Type declaration

    • (value: any): number | void

    • Parameters

      • value: any

      Returns number | void

Variables

Export assignment rangeBy

rangeBy: Routine

Calculates the range of a strided array via a callback function.

Notes

  • The callback function is provided four arguments:

    • value: array element
    • aidx: array index
    • sidx: strided index (offset + aidx*stride)
    • array: input array

  • The callback function should return a numeric value. If the callback function does not return any value (or equivalently, explicitly returns undefined), the value is ignored.

param

number of indexed elements

param

input array

param

stride length

param

callback

param

execution context

returns

range