imag

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

Installation

npm install @stdlib/complex-float32-imag

Usage

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

imag( z )

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

var Complex64 = require( '@stdlib/complex-float32-ctor' );

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

Examples

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

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

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

// 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/float32/imag.h"

stdlib_complex64_imag( z )

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

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

stdlib_complex64_t z = stdlib_complex64( 5.0f, 2.0f );

// ...

float im = stdlib_complex64_imag( z );
// returns 2.0f

The function accepts the following arguments:

• z: [in] stdlib_complex64_t single-precision complex floating-point number.

float stdlib_complex64_imag( const stdlib_complex64_t z );

Examples

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

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

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

See Also

• @stdlib/complex-float64/imag: return the imaginary component of a double-precision complex floating-point number.
• @stdlib/complex-float32/real: return the real component of a single-precision complex floating-point number.
• @stdlib/complex-float32/reim: return the real and imaginary components of a single-precision complex floating-point number.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.