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

Export assignment full

• full(length: number, value: number, dtype: "float64"): Float64Array
• full(length: number, value: number, dtype: "float32"): Float32Array
• full(length: number, value: ComplexLike, dtype: "complex128"): Complex128Array
• full(length: number, value: ComplexLike, dtype: "complex64"): Complex64Array
• full(length: number, value: number, dtype: "int32"): Int32Array
• full(length: number, value: number, dtype: "int16"): Int16Array
• full(length: number, value: number, dtype: "int8"): Int8Array
• full(length: number, value: number, dtype: "uint32"): Uint32Array
• full(length: number, value: number, dtype: "uint16"): Uint16Array
• full(length: number, value: number, dtype: "uint8"): Uint8Array
• full(length: number, value: number, dtype: "uint8c"): Uint8ClampedArray
• full(length: number, value: any, dtype: "generic"): Array<any>
• full(length: number, value: any, dtype?: DataType): AnyArray

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "float64"

    data type

  Returns Float64Array

  filled array

  Example

  var arr = full( 2, 1.0, 'float64' );
  // returns <Float64Array>[ 1.0, 1.0 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "float32"

    data type

  Returns Float32Array

  filled array

  Example

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

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: ComplexLike

    fill value

  • dtype: "complex128"

    data type

  Returns Complex128Array

  filled array

  Example

  var Complex128 = require( `@stdlib/complex/float64` );
  
  var arr = full( 2, new Complex128( 1.0, 2.0 ), 'complex128' );
  // returns <Complex128Array>

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: ComplexLike

    fill value

  • dtype: "complex64"

    data type

  Returns Complex64Array

  filled array

  Example

  var Complex64 = require( `@stdlib/complex/float32` );
  
  var arr = full( 2, new Complex64( 1.0, 2.0 ), 'complex64' );
  // returns <Complex64Array>

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "int32"

    data type

  Returns Int32Array

  filled array

  Example

  var arr = full( 2, 1, 'int32' );
  // returns <Int32Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "int16"

    data type

  Returns Int16Array

  filled array

  Example

  var arr = full( 2, 1, 'int16' );
  // returns <Int16Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "int8"

    data type

  Returns Int8Array

  filled array

  Example

  var arr = full( 2, 1, 'int8' );
  // returns <Int8Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "uint32"

    data type

  Returns Uint32Array

  filled array

  Example

  var arr = full( 2, 1, 'uint32' );
  // returns <Uint32Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "uint16"

    data type

  Returns Uint16Array

  filled array

  Example

  var arr = full( 2, 1, 'uint16' );
  // returns <Uint16Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "uint8"

    data type

  Returns Uint8Array

  filled array

  Example

  var arr = full( 2, 1, 'uint8' );
  // returns <Uint8Array>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: number

    fill value

  • dtype: "uint8c"

    data type

  Returns Uint8ClampedArray

  filled array

  Example

  var arr = full( 2, 1, 'uint8c' );
  // returns <Uint8ClampedArray>[ 1, 1 ]

• Creates a filled array having a specified length.

  Parameters

  • length: number

    array length

  • value: any

    fill value

  • dtype: "generic"

    data type

  Returns Array < any >

  filled array

  Example

  var arr = full( 2, 1, 'generic' );
  // returns [ 1, 1 ]

• Creates a filled array having a specified length.

  The function recognizes the following data types:

  • float64: double-precision floating-point numbers (IEEE 754)
  • float32: single-precision floating-point numbers (IEEE 754)
  • complex128: double-precision complex floating-point numbers
  • complex64: single-precision complex floating-point numbers
  • int32: 32-bit two's complement signed integers
  • uint32: 32-bit unsigned integers
  • int16: 16-bit two's complement signed integers
  • uint16: 16-bit unsigned integers
  • int8: 8-bit two's complement signed integers
  • uint8: 8-bit unsigned integers
  • uint8c: 8-bit unsigned integers clamped to 0-255
  • generic: generic JavaScript values

  Parameters

  • length: number

    array length

  • value: any

    fill value

  • Optional dtype: DataType

    data type (default: 'float64')

  Returns AnyArray

  filled array

  Example

  var arr = full( 2, 1.0 );
  // returns <Float64Array>[ 1.0, 1.0 ]

  Example

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