alias2related

Return aliases related to a specified alias.

Installation

npm install @stdlib/namespace-alias2related

Usage

var alias2related = require( '@stdlib/namespace-alias2related' );

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

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var aliases = require( '@stdlib/namespace-aliases' );
var alias2related = require( '@stdlib/namespace-alias2related' );

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( ', ' ) );
}

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

• @stdlib/namespace-alias2related-cli: CLI package for use as a command-line utility.
• @stdlib/namespace-alias2pkg: return the package name associated with a specified alias.
• @stdlib/namespace-aliases: standard library aliases.
• @stdlib/namespace-pkg2related: return package names related to a specified package name.

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

Copyright

Copyright © 2016-2024. The Stdlib Authors.