@stdlib/assert-is-complex128matrix-like

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!

isComplex128MatrixLike

Test if a value is a 2-dimensional ndarray-like object containing double-precision complex floating-point numbers.

Installation

npm install @stdlib/assert-is-complex128matrix-like

Usage

var isComplex128MatrixLike = require( '@stdlib/assert-is-complex128matrix-like' );

isComplex128MatrixLike( value )

Tests if a value is a 2-dimensional ndarray-like object whose underlying data type is complex128.

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

var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );

var bool = isComplex128MatrixLike( arr );
// returns true

Examples

var ndarray = require( '@stdlib/ndarray-ctor' );
var Complex128Array = require( '@stdlib/array-complex128' );
var isComplex128MatrixLike = require( '@stdlib/assert-is-complex128matrix-like' );

var buffer = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
var arr = ndarray( 'complex128', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );

var out = isComplex128MatrixLike( arr );
// returns true

out = isComplex128MatrixLike( [ 1, 2, 3, 4 ] );
// returns false

out = isComplex128MatrixLike( {} );
// returns false

out = isComplex128MatrixLike( null );
// returns false

---

See Also

• @stdlib/assert-is-complex64matrix-like: test if a value is a 2-dimensional ndarray-like object containing single-precision complex floating-point numbers.
• @stdlib/assert-is-ndarray-like: test if a value is ndarray-like.
• @stdlib/assert-is-matrix-like: test if a value is a 2-dimensional ndarray-like object.

---

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.

Changelog

0.2.0 (2024-02-14)

<section class="commits">

Commits

<details>

• dea49e0 - docs: use single quotes in require calls instead of backticks (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.1.0">