Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

Export assignment csignum

  • Evaluates the signum function of a complex number.

    Parameters

    • out: ArrayLike<number>

      output array

    • re: number

      real component

    • im: number

      imaginary component

    Returns ArrayLike < number >

    real and imaginary components

    Example

    var Float32Array = require( `@stdlib/array/float32` );
    
    var out = new Float32Array( 2 );
    
    var v = csignum( out, -4.2, 5.5 );
    // returns <Float32Array>[ -0.6069136033622302, 0.79476781392673 ]
    
    var bool = ( v === out );
    // returns true
  • Evaluates the signum function of a complex number.

    Parameters

    • re: number

      real component

    • im: number

      imaginary component

    Returns ArrayLike < number >

    real and imaginary components

    Example

    var v = csignum( -4.2, 5.5 );
    // returns [ -0.6069136033622302, 0.79476781392673 ]

    Example

    var v = csignum( 0.0, 0.0 );
    // returns [ 0.0, 0.0 ]

    Example

    var v = csignum( NaN, NaN );
    // returns [ NaN, NaN ]