@stdlib/assert-is-complex64vector-like
v0.2.2
Published
Test if a value is a 1-dimensional ndarray-like object containing single-precision complex floating-point numbers.
Downloads
15
Readme
isComplex64VectorLike
Test if a value is a 1-dimensional ndarray-like object containing single-precision complex floating-point numbers.
Installation
npm install @stdlib/assert-is-complex64vector-like
Usage
var isComplex64VectorLike = require( '@stdlib/assert-is-complex64vector-like' );
isComplex64VectorLike( value )
Tests if a value is a 1-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 ] ), [ 4 ], [ 1 ], 0, 'row-major' );
var bool = isComplex64VectorLike( arr );
// returns true
Examples
var ndarray = require( '@stdlib/ndarray-ctor' );
var Complex64Array = require( '@stdlib/array-complex64' );
var isComplex64VectorLike = require( '@stdlib/assert-is-complex64vector-like' );
var buffer = new Complex64Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
var arr = ndarray( 'complex64', buffer, [ 4 ], [ 1 ], 0, 'row-major' );
var out = isComplex64VectorLike( arr );
// returns true
out = isComplex64VectorLike( [ 1, 2, 3, 4 ] );
// returns false
out = isComplex64VectorLike( {} );
// returns false
out = isComplex64VectorLike( null );
// returns false
See Also
@stdlib/assert-is-complex128vector-like
: test if a value is a 1-dimensional ndarray-like object containing double-precision complex floating-point numbers.@stdlib/assert-is-ndarray-like
: test if a value is ndarray-like.@stdlib/assert-is-vector-like
: test if a value is a 1-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.