@stdlib/complex-imag

Return the imaginary component of a complex number.

Usage no npm install needed!

<script type="module">
  import stdlibComplexImag from 'https://cdn.skypack.dev/@stdlib/complex-imag';
</script>

README

imag

NPM version Build Status Coverage Status dependencies

Return the imaginary component of a complex number.

Installation

npm install @stdlib/complex-imag

Usage

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

imag( z )

Returns the imaginary component of a complex 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 ) );
}

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-2021. The Stdlib Authors.