isComplex

Test if a value is a 64-bit or 128-bit complex number.

Installation

npm install @stdlib/assert-is-complex

Usage

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

isComplex( value )

Tests if a value is a 64-bit or 128-bit complex number.

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

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

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

Examples

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

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

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

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

out = isComplex( null );
// returns false

See Also

• @stdlib/assert-is-complex64: test if a value is a 64-bit complex number.
• @stdlib/assert-is-complex128: test if a value is a 128-bit complex 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.