@stdlib/assert-is-complex-like

isComplexLike

Test if a value is a complex number-like object.

Installation

npm install @stdlib/assert-is-complex-like

Usage

var isComplexLike = require( '@stdlib/assert-is-complex-like' );

isComplexLike( value )

Tests if a value is a complex number-like object.

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

var x = new Complex128( 1.0, 3.0 );
var bool = isComplexLike( x );
// returns true

x = new Complex64( 3.0, 1.0 );
bool = isComplexLike( x );
// returns true

x = {
    're': 1.0,
    'im': -1.0
};
bool = isComplexLike( x );
// returns true

Notes

• A complex number-like object is defined as an object having the following properties assigned to numeric values:

  • re: real component.
  • im: imaginary component.

Examples

var Complex64 = require( '@stdlib/complex-float32' );
var Complex128 = require( '@stdlib/complex-float64' );
var isComplexLike = require( '@stdlib/assert-is-complex-like' );

var out = isComplexLike( new Complex64( 2.0, 2.0 ) );
// returns true

out = isComplexLike( new Complex128( 3.0, 1.0 ) );
// returns true

out = isComplexLike( { 're': 1.0, 'im': -1.0 } );
// returns true

out = isComplexLike( {} );
// returns false

out = isComplexLike( null );
// returns false

---

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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.1 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release -->