External module "array/typed-real/docs/types/index.d"

Export assignment realarray

• realarray(dtype?: DataType): TypedArray
• realarray(length: number, dtype?: DataType): TypedArray
• realarray(realarray: TypedArray, dtype?: DataType): TypedArray
• realarray(obj: ArrayLike<number> | Iterable<any>, dtype?: DataType): TypedArray
• realarray(buffer: ArrayBuffer, dtype?: DataType): TypedArray
• realarray(buffer: ArrayBuffer, byteOffset?: undefined | number, dtype?: DataType): TypedArray
• realarray(buffer: ArrayBuffer, byteOffset?: undefined | number, length?: undefined | number, dtype?: DataType): TypedArray

• Creates a typed array.

  Parameters

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var arr = realarray();
  // returns <Float64Array>

  Example

  var arr = realarray( 'float32');
  // returns <Float32Array>

• Creates a typed array.

  Parameters

  • length: number

    typed array length

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var arr = realarray( 2 );
  // returns <Float64Array>[ 0.0, 0.0 ]

  Example

  var arr = realarray( 2, 'float32' );
  // returns <Float32Array>[ 0.0, 0.0 ]

• Creates a typed array.

  Parameters

  • realarray: TypedArray

    typed array from which to generate another typed array

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var arr = realarray( new Float64Array( 2 ) );
  // returns <Float64Array>[ 0.0, 0.0 ]

  Example

  var arr = realarray( new Float64Array( 2 ), 'float32' );
  // returns <Float32Array>[ 0.0, 0.0 ]

  Example

  var arr1 = realarray( [ 5, 3 ], 'int32' );
  var arr2 = realarray( arr1 );
  // returns <Float64Array>[ 5.0, 3.0 ]

  Example

  var arr1 = realarray( [ 5, 3 ], 'int32' );
  var arr2 = realarray( arr1, 'uint32' );
  // returns <Uint32Array>[ 5, 3 ]

• Creates a typed array.

  Parameters

  • obj: ArrayLike<number> | Iterable<any>

    array-like object or iterable from which to generate a typed array

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var arr = realarray( [ 0.5, 0.5 ] );
  // returns <Float64Array>[ 0.5, 0.5 ]

  Example

  var arr = realarray( [ 5, -3 ], 'int32' );
  // returns <Int32Array>[ 5, -3 ]

• Creates a typed array.

  Parameters

  • buffer: ArrayBuffer

    underlying ArrayBuffer

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 16 );
  var arr = realarray( buf );
  // returns <Float64Array>[ 0.0, 0.0 ]

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 16 );
  var arr = realarray( buf, 'float32' );
  // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]

• Creates a typed array.

  Parameters

  • buffer: ArrayBuffer

    underlying ArrayBuffer

  • Optional byteOffset: undefined | number

    integer byte offset specifying the location of the first typed array element (default: 0)

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 16 );
  var arr = realarray( buf, 8 );
  // returns <Float64Array>[ 0.0 ]

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 16 );
  var arr = realarray( buf, 8, 'float32' );
  // returns <Float32Array>[ 0.0, 0.0 ]

• Creates a typed array.

  Parameters

  • buffer: ArrayBuffer

    underlying ArrayBuffer

  • Optional byteOffset: undefined | number

    integer byte offset specifying the location of the first typed array element (default: 0)

  • Optional length: undefined | number

    view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns TypedArray

  typed array

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 32 );
  var arr = realarray( buf, 8, 2 );
  // returns <Float64Array>[ 0.0, 0.0 ]

  Example

  var ArrayBuffer = require( `@stdlib/array/buffer` );
  
  var buf = new ArrayBuffer( 32 );
  var arr = realarray( buf, 8, 2, 'int32' );
  // returns <Int32Array>[ 0, 0 ]