@stdlib/math-special 0.2.0 → 0.3.0

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.
Files changed (6) hide show
  1. package/NOTICE +1 -1
  2. package/README.md +6 -6
  3. package/data/unary.json +18153 -0
  4. package/data/unary_function_database.json +2745 -0
  5. package/docs/types/index.d.ts +9 -37
  6. package/package.json +8 -47
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 value
32
+ * @param x - input ndarray
33
33
  * @param options - options
34
- * @returns result
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 v = y.get( 0, 1 );
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 v = y.get( 0, 1 );
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.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Special math functions.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -15,18 +15,14 @@
15
15
  ],
16
16
  "main": "./lib",
17
17
  "directories": {
18
+ "data": "./data",
18
19
  "doc": "./docs",
19
- "example": "./examples",
20
20
  "lib": "./lib",
21
- "test": "./test"
21
+ "scripts": "./scripts",
22
+ "dist": "./dist"
22
23
  },
23
24
  "types": "./docs/types",
24
- "scripts": {
25
- "test": "make test",
26
- "test-cov": "make test-cov",
27
- "examples": "make examples",
28
- "benchmark": "make benchmark"
29
- },
25
+ "scripts": {},
30
26
  "homepage": "https://stdlib.io",
31
27
  "repository": {
32
28
  "type": "git",
@@ -36,45 +32,10 @@
36
32
  "url": "https://github.com/stdlib-js/stdlib/issues"
37
33
  },
38
34
  "dependencies": {
39
- "@stdlib/math-special-abs": "^0.1.0",
40
- "@stdlib/utils-define-read-only-property": "^0.2.0"
41
- },
42
- "devDependencies": {
43
- "@stdlib/array-float32": "^0.2.0",
44
- "@stdlib/array-float64": "^0.2.0",
45
- "@stdlib/assert-has-property": "^0.2.0",
46
- "@stdlib/assert-is-browser": "^0.2.0",
47
- "@stdlib/assert-is-typed-array-like": "^0.2.0",
48
- "@stdlib/fs-write-file": "^0.2.0",
49
- "@stdlib/math-base-assert-is-nan": "^0.2.0",
50
- "@stdlib/math-base-special-abs": "^0.2.0",
51
- "@stdlib/math-base-special-absf": "^0.2.0",
52
- "@stdlib/math-base-special-identity": "^0.2.0",
53
- "@stdlib/math-base-special-labs": "^0.2.0",
54
- "@stdlib/math-base-special-pow": "^0.2.0",
55
- "@stdlib/math-strided-special-abs": "^0.2.0",
56
- "@stdlib/math-tools-unary": "^0.2.0",
57
- "@stdlib/ndarray-array": "^0.1.0",
58
- "@stdlib/ndarray-base-ctor": "^0.2.0",
59
- "@stdlib/ndarray-base-dtypes2signatures": "^0.2.0",
60
- "@stdlib/ndarray-base-meta-data-props": "^0.2.0",
61
- "@stdlib/ndarray-base-serialize-meta-data": "^0.2.0",
62
- "@stdlib/ndarray-base-shape2strides": "^0.2.0",
63
- "@stdlib/ndarray-base-unary": "^0.1.0",
64
- "@stdlib/ndarray-ctor": "^0.1.0",
65
- "@stdlib/ndarray-dispatch": "^0.2.0",
66
- "@stdlib/ndarray-dtypes": "^0.2.0",
67
- "@stdlib/ndarray-ind2sub": "^0.1.1",
68
- "@stdlib/random-base-uniform": "^0.1.0",
69
- "@stdlib/utils-keys": "^0.2.0",
70
- "@stdlib/utils-try-require": "^0.2.0",
71
- "proxyquire": "^2.0.0",
72
- "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
73
- "istanbul": "^0.4.1",
74
- "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
75
- "@stdlib/bench-harness": "^0.2.0",
76
- "@stdlib/bench": "^0.3.1"
35
+ "@stdlib/math-special-abs": "^0.2.1",
36
+ "@stdlib/utils-define-read-only-property": "^0.2.2"
77
37
  },
38
+ "devDependencies": {},
78
39
  "engines": {
79
40
  "node": ">=0.10.0",
80
41
  "npm": ">2.7.0"