Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "math/tools/unary/docs/types/index.d"

Index

Type aliases

ScalarFunction

ScalarFunction: (x: number) => number

Function which operates on a number.

param

input value

returns

return value

Type declaration

    • (x: number): number
    • Parameters

      • x: number

      Returns number

StridedArrayFunction

StridedArrayFunction: (N: number, x: ArrayLike<number>, strideX: number, y: ArrayLike<number>, strideY: number) => ArrayLike<number> | void

Function which operates on each element in a strided input array x and assigns the results to elements in a strided output array y.

param

number of indexed elements

param

input array

param

x stride length

param

destination array

param

y stride length

returns

y or undefined

Type declaration

StridedArrayFunctionWithOffsets

StridedArrayFunctionWithOffsets: (N: number, x: ArrayLike<number>, strideX: number, offsetX: number, y: ArrayLike<number>, strideY: number, offsetY: number) => ArrayLike<number> | void

Function which operates on each element in a strided input array x and assigns the results to elements in a strided output array y using alternative (i.e., ndarray) indexing semantics.

param

number of indexed elements

param

input array

param

x stride length

param

starting index for x

param

destination array

param

y stride length

param

starting index for y

returns

y or undefined

Type declaration

    • (N: number, x: ArrayLike<number>, strideX: number, offsetX: number, y: ArrayLike<number>, strideY: number, offsetY: number): ArrayLike<number> | void
    • Parameters

      • N: number
      • x: ArrayLike<number>
      • strideX: number
      • offsetX: number
      • y: ArrayLike<number>
      • strideY: number
      • offsetY: number

      Returns ArrayLike < number > | void

Functions

Export assignment dispatch

  • Returns a function which dispatches to specified functions based on input argument types.

    throws

    must provide valid table fields

    throws

    table field values must be array-like objects having an even number of elements

    throws

    table field values must consist of dtype-function pairs

    Parameters

    • table: Table

      resolution table object

    Returns DispatchFunction

    dispatch function

    Example

    var nabs = require( `@stdlib/math/base/special/abs` );
    var dabs = require( `@stdlib/math/strided/special/dabs` );
    var sabs = require( `@stdlib/math/strided/special/sabs` );
    var gabs = require( `@stdlib/math/strided/special/abs` );
    var Float64Array = require( `@stdlib/array/float64` );
    
    var table = {
        'scalar': [
            'number', nabs
        ],
        'array': [
            'float64', dabs,
            'float32', sabs,
            'generic', gabs
        ],
        'ndarray': [
            'float64', dabs.ndarray,
            'float32', sabs.ndarray,
            'generic', gabs.ndarray
        ]
    };
    
    var abs = dispatch( table );
    
    var x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
    var y = abs( x );
    // returns <Float64Array>[ 1.0, 2.0, 3.0 ]