isComplex128VectorLike

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

Usage

var isComplex128VectorLike = require( '@stdlib/assert/is-complex128vector-like' );

isComplex128VectorLike( value )

Tests if a value is a 1-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 ] ), [ 4 ], [ 1 ], 0, 'row-major' );

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

Examples

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

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

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

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

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

out = isComplex128VectorLike( null );
// returns false
Did you find this page helpful?