Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/assert-is-complex64ndarray-like
Test if a value is an ndarray-like object containing single-precision complex floating-point numbers.
https://github.com/stdlib-js/assert-is-complex64ndarray-like
array assert assertion complex64 float is isndarray javascript nd ndarray ndarray-like node node-js nodejs single stdlib util utilities utility utils
Last synced: 17 days ago
JSON representation
Test if a value is an ndarray-like object containing single-precision complex floating-point numbers.
- Host: GitHub
- URL: https://github.com/stdlib-js/assert-is-complex64ndarray-like
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-12-02T22:43:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-01T12:02:37.000Z (about 1 month ago)
- Last Synced: 2024-10-09T19:33:49.367Z (28 days ago)
- Topics: array, assert, assertion, complex64, float, is, isndarray, javascript, nd, ndarray, ndarray-like, node, node-js, nodejs, single, stdlib, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 643 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# isComplex64ndarrayLike
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is an [ndarray][@stdlib/ndarray/ctor]-like object containing single-precision complex floating-point numbers.
## Installation
```bash
npm install @stdlib/assert-is-complex64ndarray-like
```
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 isComplex64ndarrayLike = require( '@stdlib/assert-is-complex64ndarray-like' );
```
#### isComplex64ndarrayLike( value )
Tests if a value is an [ndarray][@stdlib/ndarray/ctor]-like object whose underlying data type is `complex64`.
```javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var arr = ndarray( 'complex64', new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var bool = isComplex64ndarrayLike( arr );
// returns true
```
## Examples
```javascript
var ndarray = require( '@stdlib/ndarray-ctor' );
var Complex64Array = require( '@stdlib/array-complex64' );
var isComplex64ndarrayLike = require( '@stdlib/assert-is-complex64ndarray-like' );
var buffer = new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
var arr = ndarray( 'complex64', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var out = isComplex64ndarrayLike( arr );
// returns true
out = isComplex64ndarrayLike( [ 1, 2, 3, 4 ] );
// returns false
out = isComplex64ndarrayLike( {} );
// returns false
out = isComplex64ndarrayLike( null );
// returns false
```
* * *
## See Also
- [`@stdlib/assert-is-complex128ndarray-like`][@stdlib/assert/is-complex128ndarray-like]: test if a value is an ndarray-like object containing double-precision complex floating-point numbers.
- [`@stdlib/assert-is-ndarray-like`][@stdlib/assert/is-ndarray-like]: test if a value is ndarray-like.
* * *
## 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-complex64ndarray-like.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-complex64ndarray-like
[test-image]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-complex64ndarray-like/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-complex64ndarray-like?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-complex64ndarray-like/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-complex64ndarray-like/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-complex64ndarray-like/main/LICENSE
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor
[@stdlib/assert/is-complex128ndarray-like]: https://github.com/stdlib-js/assert-is-complex128ndarray-like
[@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/assert-is-ndarray-like