Nondigestible Purple Mayonnaise

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

    0.0.6 • Public • Published

    isComplexTypedArray

    NPM version Build Status Coverage Status

    Test if a value is a complex typed array.

    Installation

    npm install @stdlib/assert-is-complex-typed-array

    Usage

    var isComplexTypedArray = require( '@stdlib/assert-is-complex-typed-array' );

    isComplexTypedArray( value )

    Tests if a value is a complex typed array.

    var Complex128Array = require( '@stdlib/array-complex128' );
    
    var bool = isComplexTypedArray( new Complex128Array( 10 ) );
    // returns true
    
    bool = isComplexTypedArray( [] );
    // returns false

    Examples

    var Int8Array = require( '@stdlib/array-int8' );
    var Uint8Array = require( '@stdlib/array-uint8' );
    var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
    var Int16Array = require( '@stdlib/array-int16' );
    var Uint16Array = require( '@stdlib/array-uint16' );
    var Int32Array = require( '@stdlib/array-int32' );
    var Uint32Array = require( '@stdlib/array-uint32' );
    var Float32Array = require( '@stdlib/array-float32' );
    var Float64Array = require( '@stdlib/array-float64' );
    var Complex64Array = require( '@stdlib/array-complex64' );
    var Complex128Array = require( '@stdlib/array-complex128' );
    var isComplexTypedArray = require( '@stdlib/assert-is-complex-typed-array' );
    
    var arr = new Complex64Array( 10 );
    var bool = isComplexTypedArray( arr );
    // returns true
    
    arr = new Complex128Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns true
    
    arr = new Int8Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Uint8Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Uint8ClampedArray( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Int16Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Uint16Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Int32Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Uint32Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Float32Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    arr = new Float64Array( 10 );
    bool = isComplexTypedArray( arr );
    // returns false
    
    bool = isComplexTypedArray( [] );
    // returns false
    
    bool = isComplexTypedArray( {} );
    // returns false
    
    bool = isComplexTypedArray( 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-typed-array

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    7,321

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    39.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser