@stdlib/complex-dtype

dtype

Return the data type of a complex number.

Installation

npm install @stdlib/complex-dtype

Usage

var dtype = require( '@stdlib/complex-dtype' );

dtype( value )

Returns the data type of a complex number.

var Complex128 = require( '@stdlib/complex-float64' );

var dt = dtype( new Complex128( 1.0, 2.0 ) );
// returns 'complex128'

If provided an argument having an unknown or unsupported data type, the function returns null.

var dt = dtype( 'beep' );
// returns null

Examples

var dtypes = require( '@stdlib/complex-dtypes' );
var ctors = require( '@stdlib/complex-ctors' );
var dtype = require( '@stdlib/complex-dtype' );

// Get a list of supported complex number data types:
var DTYPES = dtypes();

// For each supported data type, create a complex number and confirm its data type...
var ctor;
var dt;
var i;
for ( i = 0; i < DTYPES.length; i++ ) {
    ctor = ctors( DTYPES[ i ] );
    dt = dtype( new ctor( 1.0, 2.0 ) );
    console.log( '%s == %s => %s', DTYPES[ i ], dt, DTYPES[ i ] === dt );
}

---

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-2022. The Stdlib Authors.

Changelog

0.0.1 (2022-02-16)

No changes reported for this release.

</section> <!-- /.release -->