Socket
Socket
Sign inDemoInstall

@stdlib/complex-promotion-rules

Package Overview
Dependencies
50
Maintainers
4
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@stdlib/complex-promotion-rules

Return the complex number data type with the smallest size and closest kind to which data types can be safely cast.


Version published
Maintainers
4
Weekly downloads
7
decreased by-50%

Weekly downloads

Readme

Source
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!

Promotion Rules

NPM version Build Status Coverage Status

Return the complex number data type with the smallest size and closest "kind" to which data types can be safely cast.

Installation

npm install @stdlib/complex-promotion-rules

Usage

var promotionRules = require( '@stdlib/complex-promotion-rules' );
promotionRules( [dtype1, dtype2] )

If provided data types, returns the complex number data type with the smallest size and closest "kind" to which data types can be safely cast.

var out = promotionRules( 'complex128', 'complex64' );
// returns 'complex128'

If not provided data types, the function returns a promotion table.

var out = promotionRules();
// returns {...}

var c128 = out[ 'complex128' ];
// returns {...}

var rule = c128[ 'uint32' ];
// returns 'complex128'

If provided an unrecognized or unsupported dtype, the function returns null.

var out = promotionRules( 'foo', 'complex128' );
// returns null

Notes

  • If a data type to which data types can be safely cast does not exist (or is not supported), the function returns -1.

Examples

var dtypes = require( '@stdlib/complex-dtypes' );
var promotionRules = require( '@stdlib/complex-promotion-rules' );

var DTYPES;
var dt1;
var dt2;
var dt;
var i;
var j;

// Get the list of supported data types:
DTYPES = dtypes();

// Print the promotion rule for each pair of data types...
for ( i = 0; i < DTYPES.length; i++ ) {
    dt1 = DTYPES[ i ];
    for ( j = 0; j < DTYPES.length; j++ ) {
        dt2 = DTYPES[ j ];
        dt = promotionRules( dt1, dt2 );
        console.log( '(%s, %s) => %s', dt1, dt2, dt );
    }
}

See Also


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

Chat


License

See LICENSE.

Copyright © 2016-2024. The Stdlib Authors.

Keywords

FAQs

Last updated on 24 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc