Skip to content

Latest commit

 

History

History
278 lines (171 loc) · 9.14 KB

README.md

File metadata and controls

278 lines (171 loc) · 9.14 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!

alias2related

NPM version Build Status Coverage Status

Return aliases related to a specified alias.

Usage

To use in Observable,

alias2related = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/namespace-alias2related@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var alias2related = require( 'path/to/vendor/umd/namespace-alias2related/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/namespace-alias2related@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.alias2related;
})();
</script>

alias2related( alias )

Returns aliases related to a specified alias.

var out = alias2related( 'base.sin' );
// returns [...]

If provided an unrecognized alias, the function returns null.

var out = alias2related( 'unrecognized_alias_beep_boop_bop_bip' );
// returns null

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/namespace-aliases@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/namespace-alias2related@umd/browser.js"></script>
<script type="text/javascript">
(function () {

var list;
var len;
var idx;
var v;
var i;

list = aliases();
len = list.length;

for ( i = 0; i < 100; i++ ) {
    idx = discreteUniform( 0, len-1 );
    v = list[ idx ];
    console.log( 'alias: %s. related: %s.', v, alias2related( v ).join( ', ' ) );
}

})();
</script>
</body>
</html>

License

The data files (databases) are licensed under an Open Data Commons Public Domain Dedication & License 1.0 and their contents are licensed under Creative Commons Zero v1.0 Universal. The software is licensed under Apache License, Version 2.0.


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


Copyright

Copyright © 2016-2024. The Stdlib Authors.