@stdlib/assert-is-complex128

isComplex128

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

Installation

npm install @stdlib/assert-is-complex128

Usage

var isComplex128 = require( '@stdlib/assert-is-complex128' );

isComplex128( value )

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

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

var x = new Complex128( 1.0, 3.0 );

var bool = isComplex128( x );
// returns true

Examples

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

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

out = isComplex128( new Complex64( 2.0, 2.0 ) );
// returns false

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

out = isComplex128( 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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.