Neapolitan Pizza Margherita

    @stdlib/complex-imag
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    imag

    NPM version Build Status Coverage Status

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

    Installation

    npm install @stdlib/complex-imag

    Usage

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

    imag( z )

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

    var Complex128 = require( '@stdlib/complex-float64' );
    
    var z = new Complex128( 5.0, 3.0 );
    var im = imag( z );
    // returns 3.0

    Examples

    var Complex128 = require( '@stdlib/complex-float64' );
    var randu = require( '@stdlib/random-base-randu' );
    var round = require( '@stdlib/math-base-special-round' );
    var imag = require( '@stdlib/complex-imag' );
    
    var re;
    var im;
    var z;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        re = round( (randu()*100.0) - 50.0 );
        im = round( (randu()*50.0) - 25.0 );
        z = new Complex128( re, im );
        console.log( 'imag(%s) = %d', z.toString(), imag( z ) );
    }

    C APIs

    Usage

    #include "stdlib/complex/imag.h"

    stdlib_imag( z )

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

    #include "stdlib/complex/float64.h"
    
    stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );
    
    // ...
    
    double im = stdlib_imag( z );
    // returns 2.0

    The function accepts the following arguments:

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

    Examples

    #include "stdlib/complex/imag.h"
    #include "stdlib/complex/float64.h"
    #include <stdio.h>
    
    int main() {
        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_imag( x[ i ] ) );
        }
    }

    See Also


    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/complex-imag

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    36,295

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    41.2 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser