@stdlib/assert-is-complex64
v0.2.2
Published
Test if a value is a 64-bit complex number.
Downloads
234
Readme
isComplex64
Test if a value is a 64-bit complex number.
Installation
npm install @stdlib/assert-is-complex64
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-ctor' );
var x = new Complex64( 1.0, 3.0 );
var bool = isComplex64( x );
// returns true
Examples
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var Complex128 = require( '@stdlib/complex-float64-ctor' );
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
See Also
@stdlib/assert-is-complex
: test if a value is a 64-bit or 128-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.