Home Original page

stdlib/lib/node_modules/@stdlib/complex/dtype at develop · stdlib-js/stdlib

Return the data type of a complex number.

Usage

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

dtype( value )

Returns the data type of a complex number.

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

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 );
}

See Also