Notebook Page Margin

    @stdlib/assert-is-complex-like
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    isComplexLike

    NPM version Build Status Coverage Status

    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' );
    var Complex64 = require( '@stdlib/complex-float32' );
    
    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 an object having the following properties assigned to numeric values:

      • re: real component.
      • im: imaginary component.

    Examples

    var Complex64 = require( '@stdlib/complex-float32' );
    var Complex128 = require( '@stdlib/complex-float64' );
    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


    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-complex-like

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    22,439

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    38 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser