Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/assert-is-complex-typed-array

Test if a value is a complex typed array.
https://github.com/stdlib-js/assert-is-complex-typed-array

array assert assertion cmplx complex is isarray istyped istypedarray javascript node node-js nodejs stdlib typed typed-array util utilities utility utils

Last synced: about 2 months ago
JSON representation

Test if a value is a complex typed array.

Awesome Lists containing this project

README 

        



  

    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



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Test if a value is a complex typed array.



## Installation



```bash

npm install @stdlib/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][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] 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



```javascript

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

```



#### isComplexTypedArray( value )



Tests if a value is a complex typed array.



```javascript

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



var bool = isComplexTypedArray( new Complex128Array( 10 ) );

// returns true



bool = isComplexTypedArray( [] );

// returns false

```



## Examples



```javascript

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



-   [`@stdlib/assert-is-complex`][@stdlib/assert/is-complex]: test if a value is a 64-bit or 128-bit complex number.

-   [`@stdlib/assert-is-complex64array`][@stdlib/assert/is-complex64array]: test if a value is a Complex64Array.

-   [`@stdlib/assert-is-complex128array`][@stdlib/assert/is-complex128array]: test if a value is a Complex128Array.



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-complex-typed-array.svg

[npm-url]: https://npmjs.org/package/@stdlib/assert-is-complex-typed-array



[test-image]: https://github.com/stdlib-js/assert-is-complex-typed-array/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/assert-is-complex-typed-array/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-complex-typed-array/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-complex-typed-array?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/assert-is-complex-typed-array/tree/deno

[deno-readme]: https://github.com/stdlib-js/assert-is-complex-typed-array/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/assert-is-complex-typed-array/tree/umd

[umd-readme]: https://github.com/stdlib-js/assert-is-complex-typed-array/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/assert-is-complex-typed-array/tree/esm

[esm-readme]: https://github.com/stdlib-js/assert-is-complex-typed-array/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/assert-is-complex-typed-array/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-complex-typed-array/main/LICENSE



[@stdlib/assert/is-complex]: https://github.com/stdlib-js/assert-is-complex



[@stdlib/assert/is-complex64array]: https://github.com/stdlib-js/assert-is-complex64array



[@stdlib/assert/is-complex128array]: https://github.com/stdlib-js/assert-is-complex128array