Home Original page

stdlib/lib/node_modules/@stdlib/assert/is-complex at develop · stdlib-js/stdlib

isComplex

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

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