@stdlib/assert-is-complex64matrix-like NPM

isComplex64MatrixLike

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

Installation

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

Usage

var isComplex64MatrixLike = require( '@stdlib/assert-is-complex64matrix-like' );

isComplex64MatrixLike( value )

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

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 = isComplex64MatrixLike( arr );
// returns true

Examples

var ndarray = require( '@stdlib/ndarray-ctor' );
var Complex64Array = require( '@stdlib/array-complex64' );
var isComplex64MatrixLike = require( '@stdlib/assert-is-complex64matrix-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 = isComplex64MatrixLike( arr );
// returns true

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

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

out = isComplex64MatrixLike( null );
// 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.