@stdlib/assert-is-complex-like
v0.2.2
Published
Test if a value is a complex number-like object.
Downloads
98,373
Readme
isComplexLike
Test if a value is a complex number-like object.
Installation
npm install @stdlib/assert-is-complex-like
Usage
var isComplexLike = require( '@stdlib/assert-is-complex-like' );
isComplexLike( value )
Tests if a value is a complex number-like object
.
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var x = new Complex128( 1.0, 3.0 );
var bool = isComplexLike( x );
// returns true
x = new Complex64( 3.0, 1.0 );
bool = isComplexLike( x );
// returns true
x = {
're': 1.0,
'im': -1.0
};
bool = isComplexLike( x );
// returns true
Notes
A complex number-like
object
is defined as anobject
having the following properties assigned to numeric values:- re: real component.
- im: imaginary component.
Examples
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var isComplexLike = require( '@stdlib/assert-is-complex-like' );
var out = isComplexLike( new Complex64( 2.0, 2.0 ) );
// returns true
out = isComplexLike( new Complex128( 3.0, 1.0 ) );
// returns true
out = isComplexLike( { 're': 1.0, 'im': -1.0 } );
// returns true
out = isComplexLike( {} );
// returns false
out = isComplexLike( 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-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.