About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isComplexTypedArray

Test if a value is a complex typed array.

Installation

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

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

isComplexTypedArray( value )

Tests if a value is a complex typed array.

var Complex128Array = require( '@stdlib/array-complex128' );

var arr = new Complex128Array( 10 );
var bool = isComplexTypedArray( arr );
// returns true

Notes

• This function is not robust and that is intentional. This function provides a lower cost way to reasonably determine whether an input value is a complex typed array in order to avoid walking the prototype chain and resolving constructors, which is necessary for robust identification of cross-realm instances. For more robust validation, see @stdlib/assert-is-complex-typed-array.

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 Complex128Array = require( '@stdlib/array-complex128' );
var Complex64Array = require( '@stdlib/array-complex64' );
var isComplexTypedArray = require( '@stdlib/array-base-assert-is-complex-typed-array' );

var bool = isComplexTypedArray( new Complex128Array( 10 ) );
// returns true

bool = isComplexTypedArray( new Complex64Array( 10 ) );
// returns true

bool = isComplexTypedArray( [] );
// returns false

bool = isComplexTypedArray( new Float64Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Float32Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Int32Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Uint32Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Int16Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Uint16Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Int8Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Uint8Array( 10 ) );
// returns false

bool = isComplexTypedArray( new Uint8ClampedArray( 10 ) );
// returns false

bool = isComplexTypedArray( { 'length': 0 } );
// returns false

---

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.