Skip to content

Commit b72e804

Browse files
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents 08e2efc + 624dc11 commit b72e804

File tree

23 files changed

+57
-37
lines changed

23 files changed

+57
-37
lines changed

README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,46 +28,46 @@ This is the GitHub repository of stdlib source code and documentation. For help
2828

2929
## Features
3030

31-
- 150+ special math functions.
31+
- 150+ [special math functions][@stdlib/math/base/special].
3232

3333
<div class="image" align="center">
34-
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/5c02c2975fc3542a4c5bc9bea67e9d4a0a3331a9/docs/assets/readme/base_special_math.gif" alt="Demo showcasing special math functions">
34+
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/203839353bc74297fe641207270f7917d2bda560/docs/assets/readme/base_special_math.png" alt="Demo showcasing special math functions">
3535
</div>
3636

37-
- 35+ probability distributions.
37+
- 35+ [probability distributions][@stdlib/stats/base/dists], with support for evaluating probability density functions (PDFs), cumulative distribution functions (CDFs), quantiles, moments, and more.
3838

3939
<div class="image" align="center">
40-
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/992f297dd8976eec53f662fa71a60985bd4ed339/docs/assets/readme/base_dists.gif" alt="Demo showcasing probability distributions">
40+
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/e13885087939c064c69aa43ee80ea52710de5591/docs/assets/readme/base_dists.png" alt="Demo showcasing probability distributions">
4141
</div>
4242

43-
- 35+ seedable pseudorandom number generators (PRNGs).
43+
- 35+ [seedable pseudorandom number generators][@stdlib/random/base] (PRNGs).
4444

4545
<div class="image" align="center">
46-
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/604585afe70f33f419a43d891f73c484b0a21126/docs/assets/readme/base_prngs.gif" alt="Demo showcasing PRNGs">
46+
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/83dcd0fad98883320a8b1efc801b2fc1ed2a003d/docs/assets/readme/base_prngs.png" alt="Demo showcasing PRNGs">
4747
</div>
4848

49-
- 160+ general utilities for data transformation, functional programming, and asynchronous control flow.
49+
- 160+ general [utilities][@stdlib/utils] for data transformation, functional programming, and asynchronous control flow.
5050

5151
<div class="image" align="center">
5252
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/e6eeea31e49d6db1b6f57ae59d2988d4b427e285/docs/assets/readme/utils.png" alt="Demo showcasing general utilities">
5353
</div>
5454

55-
- 170+ assertion utilities for data validation and feature detection.
55+
- 170+ [assertion utilities][@stdlib/assert] for data validation and feature detection.
5656

5757
<div class="image" align="center">
5858
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/6970c8b4eb546a10712734d225c15863db9b2c92/docs/assets/readme/assert.png" alt="Demo showcasing assertion utilities">
5959
</div>
6060

61-
- 50+ sample datasets for testing and development.
61+
- 50+ [sample datasets][@stdlib/datasets] for testing and development.
6262

6363
<div class="image" align="center">
64-
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/cd0ec30ed9ecc776e30bd9c85d08d46c614c51c2/docs/assets/readme/datasets.gif" alt="Demo showcasing sample datasets">
64+
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/f71a38e62247e31dc47d248f6f1b3e434abeb971/docs/assets/readme/datasets.png" alt="Demo showcasing sample datasets">
6565
</div>
6666

67-
- A plot API for data visualization and exploratory data analysis.
67+
- A [plot API][@stdlib/plot/ctor] for data visualization and exploratory data analysis.
6868

6969
<div class="image" align="center">
70-
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/ae071998112225a6fb921605565ff767bc854c49/docs/assets/readme/plot.gif" alt="Demo showcasing plot API">
70+
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/39d75174b24ea2a84828d9624643776a164478e4/docs/assets/readme/plot.png" alt="Demo showcasing plot API">
7171
</div>
7272

7373
- Native add-ons for interfacing with BLAS libraries, with pure JavaScript fallbacks.
@@ -76,7 +76,7 @@ This is the GitHub repository of stdlib source code and documentation. For help
7676
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/efede6af3ef957da08838903b0558441263adf85/docs/assets/readme/base_blas.png" alt="Demo showcasing BLAS APIs">
7777
</div>
7878

79-
- A benchmark framework supporting TAP.
79+
- A [benchmark framework][@stdlib/bench/harness] supporting TAP.
8080

8181
<div class="image" align="center">
8282
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/4833049f8d1895585bd51ec6fa97b8ca0d37c6fb/docs/assets/readme/benchmark.gif" alt="Demo showcasing benchmark framework">
@@ -138,6 +138,8 @@ To install as a library or application dependency,
138138
$ npm install @stdlib/stdlib
139139
```
140140

141+
For distributable bundles for use in browser environments, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles].
142+
141143
Otherwise, to install as a system library, follow the [download][stdlib-development], [configuration][stdlib-development], and [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
142144

143145
* * *
@@ -330,12 +332,30 @@ Copyright © 2016-2018. The Stdlib [Authors][stdlib-authors].
330332

331333
[stdlib-source]: https://github.com/stdlib-js/stdlib
332334

335+
[stdlib-bundles]: https://github.com/stdlib-js/stdlib/tree/develop/dist
336+
333337
[stdlib-code-coverage]: https://codecov.io/github/stdlib-js/stdlib/branch/develop
334338

335339
[stdlib-twitter]: https://twitter.com/stdlibjs
336340

337341
[stdlib-gitter]: https://gitter.im/stdlib-js/stdlib
338342

343+
[@stdlib/math/base/special]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special
344+
345+
[@stdlib/stats/base/dists]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists
346+
347+
[@stdlib/random/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base
348+
349+
[@stdlib/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert
350+
351+
[@stdlib/datasets]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets
352+
353+
[@stdlib/utils]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils
354+
355+
[@stdlib/plot/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/plot/ctor
356+
357+
[@stdlib/bench/harness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/bench/harness
358+
339359
</section>
340360

341361
<!-- /.links -->

docs/assets/readme/base_dists.gif

-159 KB
Binary file not shown.

docs/assets/readme/base_dists.png

316 KB
Loading

docs/assets/readme/base_prngs.gif

-1.28 MB
Binary file not shown.

docs/assets/readme/base_prngs.png

114 KB
Loading
-134 KB
Binary file not shown.
305 KB
Loading

docs/assets/readme/datasets.gif

-166 KB
Binary file not shown.

docs/assets/readme/datasets.png

349 KB
Loading

docs/assets/readme/plot.gif

-171 KB
Binary file not shown.

docs/assets/readme/plot.png

313 KB
Loading

lib/node_modules/@stdlib/math/base/special/covercos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = covercos( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var covercos = require( '@stdlib/math/base/special/covercos' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/covercos/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var covercos = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/coversin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = coversin( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var coversin = require( '@stdlib/math/base/special/coversin' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/coversin/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var coversin = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/hacovercos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = hacovercos( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var hacovercos = require( '@stdlib/math/base/special/hacovercos' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/hacovercos/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var hacovercos = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/hacoversin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = hacoversin( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var hacoversin = require( '@stdlib/math/base/special/hacoversin' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/hacoversin/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var hacoversin = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/havercos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = havercos( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var havercos = require( '@stdlib/math/base/special/havercos' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/havercos/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var havercos = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/haversin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ v = haversin( -3.141592653589793/6.0 );
7474

7575
```javascript
7676
var linspace = require( '@stdlib/math/utils/linspace' );
77-
var PI = require( '@stdlib/constants/math/float64-pi' );
77+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
7878
var haversin = require( '@stdlib/math/base/special/haversin' );
7979

80-
var x = linspace( 0.0, 2.0*PI, 100 );
80+
var x = linspace( 0.0, TWO_PI, 100 );
8181
var i;
8282

8383
for ( i = 0; i < x.length; i++ ) {

lib/node_modules/@stdlib/math/base/special/haversin/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
'use strict';
2020

2121
var linspace = require( '@stdlib/math/utils/linspace' );
22-
var PI = require( '@stdlib/constants/math/float64-pi' );
22+
var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
2323
var haversin = require( './../lib' );
2424

25-
var x = linspace( 0.0, 2.0*PI, 100 );
25+
var x = linspace( 0.0, TWO_PI, 100 );
2626
var i;
2727

2828
for ( i = 0; i < x.length; i++ ) {

0 commit comments

Comments
 (0)