1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<!--
@license Apache-2.0
Copyright (c) 2019 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# alias2related
> Return aliases related to a specified alias.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
</section>
<!-- /.intro -->
<!-- Package usage documentation. -->
<section class="usage">
## Usage
```javascript
var alias2related = require( '@stdlib/namespace/alias2related' );
```
#### alias2related( alias )
Returns aliases related to a specified `alias`.
```javascript
var out = alias2related( 'base.sin' );
// returns [...]
```
If provided an unrecognized `alias`, the function returns `null`.
```javascript
var out = alias2related( 'unrecognized_alias_beep_boop_bop_bip' );
// returns null
```
</section>
<!-- /.usage -->
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- Package usage examples. -->
<section class="examples">
## Examples
<!-- TODO: better example -->
<!-- eslint no-undef: "error" -->
```javascript
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( ', ' ) );
}
```
</section>
<!-- /.examples -->
<!-- Section for describing a command-line interface. -->
* * *
<section class="cli">
## CLI
<!-- CLI usage documentation. -->
<section class="usage">
### Usage
```text
Usage: stdlib-alias2related [options] <alias>
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
</section>
<!-- /.usage -->
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- CLI usage examples. -->
<section class="examples">
### Examples
```bash
$ stdlib-alias2related 'base.sin'
```
</section>
<!-- /.examples -->
</section>
<!-- /.cli -->
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="references">
</section>
<!-- /.references -->
<!-- <license> -->
## License
The data files (databases) are licensed under an [Open Data Commons Public Domain Dedication & License 1.0][pddl-1.0] and their contents are licensed under [Creative Commons Zero v1.0 Universal][cc0]. The software is licensed under [Apache License, Version 2.0][apache-license].
<!-- </license> -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[pddl-1.0]: http://opendatacommons.org/licenses/pddl/1.0/
[cc0]: https://creativecommons.org/publicdomain/zero/1.0
[apache-license]: https://www.apache.org/licenses/LICENSE-2.0
</section>
<!-- /.links -->
|
