External module "math/base/special/croundn/docs/types/index.d"

Export assignment croundn

• croundn(out: ArrayLike<number>, re: number, im: number, n: number): ArrayLike<number>
• croundn(re: number, im: number, n: number): ArrayLike<number>

• Rounds a complex number to the nearest multiple of 10^n.

  Notes

  • When operating on floating-point numbers in bases other than 2, rounding to specified digits can be inexact.

  Parameters

  • out: ArrayLike<number>

    output array

  • re: number

    real component

  • im: number

    imaginary component

  • n: number

    integer power of 10

  Returns ArrayLike < number >

  real and imaginary components

  Example

  var Float32Array = require( `@stdlib/array/float32` );
  
  var out = new Float32Array( 2 );
  
  var v = croundn( out, 5.555, -3.333, -2 );
  // returns <Float32Array>[ 5.56, -3.34 ]
  
  var bool = ( v === out );
  // returns true

• Rounds a complex number to the nearest multiple of 10^n.

  Notes

  • When operating on floating-point numbers in bases other than 2, rounding to specified digits can be inexact.

  Parameters

  • re: number

    real component

  • im: number

    imaginary component

  • n: number

    integer power of 10

  Returns ArrayLike < number >

  real and imaginary components

  Example

  var out = croundn( 5.555, -3.333, -2 );
  // returns [ 5.56, -3.34 ]