isComplex128MatrixLike

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

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