@stdlib/math-special 0.0.2 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2021 The Stdlib Authors.
1
+ Copyright (c) 2016-2022 The Stdlib Authors.
package/README.md CHANGED
@@ -20,9 +20,9 @@ limitations under the License.
20
20
 
21
21
  # Special Functions
22
22
 
23
- [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
23
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
24
24
 
25
- > Standard library special math functions.
25
+ > Special math functions.
26
26
 
27
27
  <section class="installation">
28
28
 
@@ -44,7 +44,7 @@ var ns = require( '@stdlib/math-special' );
44
44
 
45
45
  #### ns
46
46
 
47
- Standard library special math functions.
47
+ Namespace containing special math functions.
48
48
 
49
49
  ```javascript
50
50
  var o = ns;
@@ -55,30 +55,44 @@ var o = ns;
55
55
 
56
56
  <!-- <toc pattern="+(*log*|ln|exp*|*pow*)" ignore="logit" > -->
57
57
 
58
+
59
+
58
60
  <!-- </toc> -->
59
61
 
60
62
  ### Trigonometric Functions
61
63
 
62
64
  <!-- <toc pattern="*+(sin|cos|tan)*" ignore="+(kernel-sin|kernel-cos|kernel-tan)"> -->
63
65
 
66
+
67
+
64
68
  <!-- </toc> -->
65
69
 
66
70
  ### Bessel Functions
67
71
 
68
72
  <!-- <toc pattern="*bessel*" > -->
69
73
 
74
+
75
+
70
76
  <!-- </toc> -->
71
77
 
72
78
  ### Absolute Value and Rounding Functions
73
79
 
74
80
  <!-- <toc pattern="*+(abs|ceil|floor|clamp|trunc|round|signum)*" > -->
75
81
 
82
+ <div class="namespace-toc">
83
+
84
+ - <span class="signature">[`abs( x[, options] )`][@stdlib/math/special/abs]</span><span class="delimiter">: </span><span class="description">compute the absolute value.</span>
85
+
86
+ </div>
87
+
76
88
  <!-- </toc> -->
77
89
 
78
90
  ### Other Special Functions
79
91
 
80
92
  <!-- <toc ignore="*bessel*" ignore="*+(sin|cos|tan)*" ignore="+(*log*|ln|exp*|*pow*)" ignore="*+(abs|ceil|floor|clamp|trunc|round|signum)*" ignore="+(gamma-delta-ratio|gamma-lanczos-sum*|rempio2|kernel-*)" > -->
81
93
 
94
+
95
+
82
96
  <!-- </toc> -->
83
97
 
84
98
  </section>
@@ -104,6 +118,16 @@ console.log( objectKeys( ns ) );
104
118
 
105
119
  <!-- /.examples -->
106
120
 
121
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
122
+
123
+ <section class="related">
124
+
125
+ </section>
126
+
127
+ <!-- /.related -->
128
+
129
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
130
+
107
131
 
108
132
  <section class="main-repo" >
109
133
 
@@ -115,6 +139,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
115
139
 
116
140
  For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
117
141
 
142
+ #### Community
143
+
144
+ [![Chat][chat-image]][chat-url]
145
+
118
146
  ---
119
147
 
120
148
  ## License
@@ -124,7 +152,7 @@ See [LICENSE][stdlib-license].
124
152
 
125
153
  ## Copyright
126
154
 
127
- Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
155
+ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
128
156
 
129
157
  </section>
130
158
 
@@ -143,9 +171,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
143
171
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-special/main.svg
144
172
  [coverage-url]: https://codecov.io/github/stdlib-js/math-special?branch=main
145
173
 
146
- [dependencies-image]: https://img.shields.io/david/stdlib-js/math-special
174
+ <!--
175
+
176
+ [dependencies-image]: https://img.shields.io/david/stdlib-js/math-special.svg
147
177
  [dependencies-url]: https://david-dm.org/stdlib-js/math-special/main
148
178
 
179
+ -->
180
+
181
+ [umd]: https://github.com/umdjs/umd
182
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
183
+
184
+ [deno-url]: https://github.com/stdlib-js/math-special/tree/deno
185
+ [umd-url]: https://github.com/stdlib-js/math-special/tree/umd
186
+ [esm-url]: https://github.com/stdlib-js/math-special/tree/esm
187
+
188
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
189
+ [chat-url]: https://gitter.im/stdlib-js/stdlib/
190
+
149
191
  [stdlib]: https://github.com/stdlib-js/stdlib
150
192
 
151
193
  [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
@@ -154,6 +196,8 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
154
196
 
155
197
  <!-- <toc-links> -->
156
198
 
199
+ [@stdlib/math/special/abs]: https://www.npmjs.com/package/@stdlib/math-special-abs
200
+
157
201
  <!-- </toc-links> -->
158
202
 
159
203
  </section>
@@ -94,7 +94,7 @@ interface Namespace {
94
94
  }
95
95
 
96
96
  /**
97
- * Standard library special math functions.
97
+ * Special math functions.
98
98
  */
99
99
  declare var ns: Namespace;
100
100
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stdlib/math-special",
3
- "version": "0.0.2",
4
- "description": "Standard library special math functions.",
3
+ "version": "0.0.6",
4
+ "description": "Special math functions.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
7
7
  "name": "The Stdlib Authors",
@@ -15,6 +15,7 @@
15
15
  ],
16
16
  "main": "./lib",
17
17
  "directories": {
18
+ "doc": "./docs",
18
19
  "example": "./examples",
19
20
  "lib": "./lib",
20
21
  "test": "./test"
@@ -26,7 +27,7 @@
26
27
  "examples": "make examples",
27
28
  "benchmark": "make benchmark"
28
29
  },
29
- "homepage": "https://github.com/stdlib-js/stdlib",
30
+ "homepage": "https://stdlib.io",
30
31
  "repository": {
31
32
  "type": "git",
32
33
  "url": "git://github.com/stdlib-js/math-special.git"
@@ -45,6 +46,7 @@
45
46
  "@stdlib/assert-is-browser": "^0.0.x",
46
47
  "@stdlib/assert-is-typed-array-like": "^0.0.x",
47
48
  "@stdlib/bench": "^0.0.x",
49
+ "@stdlib/fs-write-file": "^0.0.x",
48
50
  "@stdlib/math-base-assert-is-nan": "^0.0.x",
49
51
  "@stdlib/math-base-special-abs": "^0.0.x",
50
52
  "@stdlib/math-base-special-absf": "^0.0.x",
@@ -56,16 +58,15 @@
56
58
  "@stdlib/ndarray-array": "^0.0.x",
57
59
  "@stdlib/ndarray-base-ctor": "^0.0.x",
58
60
  "@stdlib/ndarray-base-dtypes2signatures": "^0.0.x",
61
+ "@stdlib/ndarray-base-meta-data-props": "^0.0.x",
59
62
  "@stdlib/ndarray-base-serialize-meta-data": "^0.0.x",
60
63
  "@stdlib/ndarray-base-shape2strides": "^0.0.x",
61
64
  "@stdlib/ndarray-base-unary": "^0.0.x",
62
65
  "@stdlib/ndarray-ctor": "^0.0.x",
63
66
  "@stdlib/ndarray-dispatch": "^0.0.x",
67
+ "@stdlib/ndarray-dtypes": "^0.0.x",
64
68
  "@stdlib/ndarray-ind2sub": "^0.0.x",
65
69
  "@stdlib/random-base-uniform": "^0.0.x",
66
- "@stdlib/utils-copy": "^0.0.x",
67
- "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.x",
68
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
69
70
  "@stdlib/utils-keys": "^0.0.x",
70
71
  "@stdlib/utils-try-require": "^0.0.x",
71
72
  "proxyquire": "^2.0.0",
package/CHANGELOG.md DELETED
@@ -1,5 +0,0 @@
1
- # CHANGELOG
2
-
3
- > Package changelog.
4
-
5
- See [GitHub Releases](https://github.com/stdlib-js/math-special/releases) for the changelog.