time-to-botec/js/node_modules/@stdlib/assert/is-complex64/README.md

isComplex64

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

Usage

var isComplex64 = require( '@stdlib/assert/is-complex64' );

isComplex64( value )

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

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

var x = new Complex64( 1.0, 3.0 );

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

Examples

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

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

out = isComplex64( new Complex128( 3.0, 1.0 ) );
// returns false

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

out = isComplex64( null );
// returns false