@stdlib/math-special 0.2.1 → 0.3.1
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 +1 -1
- package/README.md +6 -6
- package/data/unary.json +18153 -0
- package/data/unary_function_database.json +2745 -0
- package/docs/types/index.d.ts +9 -37
- package/package.json +5 -3
package/docs/types/index.d.ts
CHANGED
|
@@ -27,17 +27,14 @@ import abs = require( '@stdlib/math-special-abs' );
|
|
|
27
27
|
*/
|
|
28
28
|
interface Namespace {
|
|
29
29
|
/**
|
|
30
|
-
* Computes the absolute value.
|
|
30
|
+
* Computes the absolute value for each element in an ndarray.
|
|
31
31
|
*
|
|
32
|
-
* @param x - input
|
|
32
|
+
* @param x - input ndarray
|
|
33
33
|
* @param options - options
|
|
34
|
-
* @returns
|
|
35
|
-
*
|
|
36
|
-
* @example
|
|
37
|
-
* var y = ns.abs( -1.0 );
|
|
38
|
-
* // returns 1.0
|
|
34
|
+
* @returns output ndarray
|
|
39
35
|
*
|
|
40
36
|
* @example
|
|
37
|
+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
|
|
41
38
|
* var array = require( '@stdlib/ndarray-array' );
|
|
42
39
|
*
|
|
43
40
|
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
|
|
@@ -45,24 +42,11 @@ interface Namespace {
|
|
|
45
42
|
* var y = ns.abs( x );
|
|
46
43
|
* // returns <ndarray>
|
|
47
44
|
*
|
|
48
|
-
* var
|
|
49
|
-
* // returns 2.0
|
|
50
|
-
*
|
|
51
|
-
* @example
|
|
52
|
-
* var Float64Array = require( '@stdlib/array-float64' );
|
|
53
|
-
*
|
|
54
|
-
* var x = new Float64Array( [ -1.0, -2.0 ] );
|
|
55
|
-
*
|
|
56
|
-
* var y = ns.abs( x );
|
|
57
|
-
* // returns <Float64Array>[ 1.0, 2.0 ]
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* var x = [ -1.0, -2.0 ];
|
|
61
|
-
*
|
|
62
|
-
* var y = ns.abs( x );
|
|
63
|
-
* // returns [ 1.0, 2.0 ]
|
|
45
|
+
* var arr = ndarray2array( y );
|
|
46
|
+
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
|
|
64
47
|
*
|
|
65
48
|
* @example
|
|
49
|
+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
|
|
66
50
|
* var array = require( '@stdlib/ndarray-array' );
|
|
67
51
|
*
|
|
68
52
|
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
|
|
@@ -74,20 +58,8 @@ interface Namespace {
|
|
|
74
58
|
* var bool = ( z === y );
|
|
75
59
|
* // returns true
|
|
76
60
|
*
|
|
77
|
-
* var
|
|
78
|
-
* // returns 2.0
|
|
79
|
-
*
|
|
80
|
-
* @example
|
|
81
|
-
* var Float64Array = require( '@stdlib/array-float64' );
|
|
82
|
-
*
|
|
83
|
-
* var x = new Float64Array( [ -1.0, -2.0 ] );
|
|
84
|
-
* var y = new Float64Array( x.length );
|
|
85
|
-
*
|
|
86
|
-
* var z = ns.abs.assign( x, y );
|
|
87
|
-
* // returns <Float64Array>[ 1.0, 2.0 ]
|
|
88
|
-
*
|
|
89
|
-
* var bool = ( z === y );
|
|
90
|
-
* // returns true
|
|
61
|
+
* var arr = ndarray2array( y );
|
|
62
|
+
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
|
|
91
63
|
*/
|
|
92
64
|
abs: typeof abs;
|
|
93
65
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/math-special",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Special math functions.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -15,8 +15,10 @@
|
|
|
15
15
|
],
|
|
16
16
|
"main": "./lib",
|
|
17
17
|
"directories": {
|
|
18
|
+
"data": "./data",
|
|
18
19
|
"doc": "./docs",
|
|
19
20
|
"lib": "./lib",
|
|
21
|
+
"scripts": "./scripts",
|
|
20
22
|
"dist": "./dist"
|
|
21
23
|
},
|
|
22
24
|
"types": "./docs/types",
|
|
@@ -30,8 +32,8 @@
|
|
|
30
32
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
31
33
|
},
|
|
32
34
|
"dependencies": {
|
|
33
|
-
"@stdlib/math-special-abs": "^0.
|
|
34
|
-
"@stdlib/utils-define-read-only-property": "^0.2.
|
|
35
|
+
"@stdlib/math-special-abs": "^0.3.0",
|
|
36
|
+
"@stdlib/utils-define-read-only-property": "^0.2.3"
|
|
35
37
|
},
|
|
36
38
|
"devDependencies": {},
|
|
37
39
|
"engines": {
|