Skip to content

Latest commit

 

History

History
234 lines (141 loc) · 7.26 KB

README.md

File metadata and controls

234 lines (141 loc) · 7.26 KB
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

dtype

NPM version Build Status Coverage Status

Return the data type of a complex number.

Usage

import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-dtype@esm/index.mjs';

dtype( value )

Returns the data type of a complex number.

import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs';

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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-dtypes@esm/index.mjs';
import ctors from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-ctors@esm/index.mjs';
import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-dtype@esm/index.mjs';

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

</script>
</body>
</html>

See Also


Notice

This package is part of stdlib, a standard library 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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.