Home Original page

stdlib/lib/node_modules/@stdlib/complex/float64/imag at develop · stdlib-js/stdlib

Return the imaginary component of a double-precision complex floating-point number.

Usage

var imag = require( '@stdlib/complex/float64/imag' );

imag( z )

Returns the imaginary component of a double-precision complex floating-point number.

var Complex128 = require( '@stdlib/complex/float64/ctor' );

var z = new Complex128( 5.0, 3.0 );
var im = imag( z );
// returns 3.0

Examples

var Complex128 = require( '@stdlib/complex/float64/ctor' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var imag = require( '@stdlib/complex/float64/imag' );

function random() {
    return new Complex128( discreteUniform( -10, 10 ), discreteUniform( -10, 10 ) );
}

// Generate an array of random complex numbers:
var x = filledarrayBy( 100, 'complex128', random );
// returns <Complex128Array>

// Retrieve the imaginary component of each complex number...
var z;
var i;
for ( i = 0; i < x.length; i++ ) {
    z = x.get( i );
    console.log( 'imag(%s) = %d', z.toString(), imag( z ) );
}

C APIs

Usage

#include "stdlib/complex/float64/imag.h"

stdlib_complex128_imag( z )

Returns the imaginary component of a double-precision complex floating-point number.

#include "stdlib/complex/float64/ctor.h"

stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );

// ...

double im = stdlib_complex128_imag( z );
// returns 2.0

The function accepts the following arguments:

  • z: [in] stdlib_complex128_t double-precision complex floating-point number.
double stdlib_complex128_imag( const stdlib_complex128_t z );

Examples

#include "stdlib/complex/float64/imag.h"
#include "stdlib/complex/float64/ctor.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex128_t x[] = {
        stdlib_complex128( 5.0, 2.0 ),
        stdlib_complex128( -2.0, 1.0 ),
        stdlib_complex128( 0.0, -0.0 ),
        stdlib_complex128( 0.0/0.0, 0.0/0.0 )
    };

    int i;
    for ( i = 0; i < 4; i++ ) {
        printf( "imag(v) = %lf\n", stdlib_complex128_imag( x[ i ] ) );
    }
}

See Also