External module "ndarray/from-scalar/docs/types/index.d"

scalar2ndarray

• scalar2ndarray(value: number, dtype: "float64"): float64ndarray
• scalar2ndarray(value: number, dtype: "float32"): float32ndarray
• scalar2ndarray(value: number | ComplexLike, dtype: "complex128"): complex128ndarray
• scalar2ndarray(value: number | ComplexLike, dtype: "complex64"): complex64ndarray
• scalar2ndarray(value: number, dtype: "int32"): int32ndarray
• scalar2ndarray(value: number, dtype: "int16"): int16ndarray
• scalar2ndarray(value: number, dtype: "int8"): int8ndarray
• scalar2ndarray(value: number, dtype: "uint32"): uint32ndarray
• scalar2ndarray(value: number, dtype: "uint16"): uint16ndarray
• scalar2ndarray(value: number, dtype: "uint8"): uint8ndarray
• scalar2ndarray(value: number, dtype: "uint8c"): uint8cndarray
• scalar2ndarray(value: any, dtype?: DataType): ndarray

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "float64"

    array data type

  Returns float64ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1.0, 'float64' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'float64'
  
  var v = x.get();
  // returns 1.0

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "float32"

    array data type

  Returns float32ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1.0, 'float32' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'float32'
  
  var v = x.get();
  // returns 1.0

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Notes

  • If provided a number, the function returns a zero-dimensional ndarray containing a complex number whose real component equals the provided scalar value and whose imaginary component is zero.

  Parameters

  • value: number | ComplexLike

    scalar value

  • dtype: "complex128"

    array data type

  Returns complex128ndarray

  zero-dimensional ndarray

  Example

  var Complex128 = require( `@stdlib/complex/float64` );
  var real = require( '@stdlib/complex/real' );
  var imag = require( '@stdlib/complex/imag' );
  
  var v = new Complex128( 1.0, 2.0 );
  
  var x = scalar2ndarray( v, 'complex128' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'complex128'
  
  var v = x.get();
  // returns <Complex128>
  
  var re = real( v );
  // returns 1.0
  
  var im = imag( v );
  // returns 2.0

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Notes

  • If provided a number, the function returns a zero-dimensional ndarray containing a complex number whose real component equals the provided scalar value and whose imaginary component is zero.

  Parameters

  • value: number | ComplexLike

    scalar value

  • dtype: "complex64"

    array data type

  Returns complex64ndarray

  zero-dimensional ndarray

  Example

  var Complex64 = require( `@stdlib/complex/float64` );
  var realf = require( '@stdlib/complex/realf' );
  var imagf = require( '@stdlib/complex/imagf' );
  
  var v = new Complex64( 1.0, 2.0 );
  
  var x = scalar2ndarray( v, 'complex64' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'complex64'
  
  var v = x.get();
  // returns <Complex64>
  
  var re = realf( v );
  // returns 1.0
  
  var im = imagf( v );
  // returns 2.0

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "int32"

    array data type

  Returns int32ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'int32' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'int32'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "int16"

    array data type

  Returns int16ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'int16' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'int16'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "int8"

    array data type

  Returns int8ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'int8' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'int8'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "uint32"

    array data type

  Returns uint32ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'uint32' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'uint32'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "uint16"

    array data type

  Returns uint16ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'uint16' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'uint16'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "uint8"

    array data type

  Returns uint8ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'uint8' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'uint8'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Parameters

  • value: number

    scalar value

  • dtype: "uint8c"

    array data type

  Returns uint8cndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1, 'uint8c' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'uint8c'
  
  var v = x.get();
  // returns 1

• Returns a zero-dimensional ndarray containing a provided scalar value.

  Notes

  • If dtype is not provided and value

    • is a number, the default data type is 'float64'.
    • is a complex number object, the default data type is 'complex128'.
    • is any other value type, the default data type is 'generic'.

  Parameters

  • value: any

    scalar value

  • Optional dtype: DataType

    array data type

  Returns ndarray

  zero-dimensional ndarray

  Example

  var x = scalar2ndarray( 1.0, 'generic' );
  // returns <ndarray>
  
  var sh = x.shape;
  // returns []
  
  var dt = x.dtype;
  // returns 'generic'
  
  var v = x.get();
  // returns 1.0