External module "ndarray/array/docs/types/index.d"

array

• array(options: OptionsWithShape | OptionsWithBuffer): ndarray
• array(buffer: ArrayLike<any>, options?: ExtendedOptions): ndarray

• Returns a multidimensional array.

  throws

  must provide valid options

  throws

  must provide either an array shape, data source, or both

  throws

  invalid cast

  throws

  data source must be compatible with specified meta data

  Parameters

  • options: OptionsWithShape | OptionsWithBuffer

    function options

  Returns ndarray

  ndarray instance

  Example

  var opts = {
      'buffer': [ [ 1, 2 ], [ 3, 4 ] ],
      'dtype': 'generic',
      'flatten': false
  };
  
  var arr = array( opts );
  // returns <ndarray>
  
  var v = arr.get( 0 );
  // returns [ 1, 2 ]

• Returns a multidimensional array.

  throws

  must provide valid options

  throws

  must provide either an array shape, data source, or both

  throws

  invalid cast

  throws

  data source must be compatible with specified meta data

  Parameters

  • buffer: ArrayLike<any>

    data source

  • Optional options: ExtendedOptions

    function options

  Returns ndarray

  ndarray instance

  Example

  var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );
  // returns <ndarray>
  
  var v = arr.get( 0, 0 );
  // returns 1

  Example

  var opts = {
      'dtype': 'generic',
      'flatten': false
  };
  
  var arr = array( [ [ 1, 2 ], [ 3, 4 ] ], opts );
  // returns <ndarray>
  
  var v = arr.get( 0 );
  // returns [ 1, 2 ]

  Example

  var Float64Array = require( '@stdlib/array/float64' );
  
  var opts = {
      'shape': [ 2, 2 ]
  };
  
  var arr = array( new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ), opts );
  // returns <ndarray>
  
  var v = arr.get( 0, 0 );
  // returns 1.0