External module "ndarray/base/unary/docs/types/index.d"

unary

• unary(arrays: ArrayLike<ndarray>, fcn: Unary): void

• Applies a unary callback to elements in an ndarray and assigns results to elements in an ndarray.

  throws

  arrays must have the same number of dimensions

  throws

  arrays must have the same shape

  Parameters

  • arrays: ArrayLike<ndarray>

    array-like object containing one input ndarray and one output ndarray

  • fcn: Unary

    unary callback

  Returns void

  Example

  var Float64Array = require( `@stdlib/array/float64` );
  var ndarray = require( `@stdlib/ndarray/ctor` );
  
  function scale( x ) {
      return x * 10.0;
  }
  
  // Create data buffers:
  var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
  var ybuf = new Float64Array( 6 );
  
  // Define the shape of the input and output arrays:
  var shape = [ 3, 1, 2 ];
  
  // Define the array strides:
  var sx = [ 4, 4, 1 ];
  var sy = [ 2, 2, 1 ];
  
  // Define the index offsets:
  var ox = 1;
  var oy = 0;
  
  // Create the input and output ndarrays:
  var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' );
  var y = ndarray( 'float64', ybuf, shape, sy, oy, 'row-major' );
  
  // Apply the unary function:
  unary( [ x, y ], scale );
  
  console.log( y.data );
  // => <Float64Array>[ 20.0, 30.0, 60.0, 70.0, 100.0, 110.0 ]