@stdlib/complex-base 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/README.md +2 -5
  2. package/dist/index.js +1 -1
  3. package/dist/index.js.map +2 -2
  4. package/docs/types/index.d.ts +6 -12
  5. package/lib/index.js +0 -9
  6. package/package.json +7 -51
package/README.md CHANGED
@@ -68,7 +68,6 @@ The namespace contains the following functions:
68
68
 
69
69
  <div class="namespace-toc">
70
70
 
71
- - <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base complex number assert functions.</span>
72
71
  - <span class="signature">[`cast( fcn, nargs, ctor )`][@stdlib/complex/base/cast-return]</span><span class="delimiter">: </span><span class="description">wrap a function and cast a function's return value to a complex number.</span>
73
72
  - <span class="signature">[`wrap( fcn, nargs, ctor )`][@stdlib/complex/base/wrap-function]</span><span class="delimiter">: </span><span class="description">wrap a function accepting complex number arguments to support providing both real and complex numbers.</span>
74
73
 
@@ -154,8 +153,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
154
153
  [npm-image]: http://img.shields.io/npm/v/@stdlib/complex-base.svg
155
154
  [npm-url]: https://npmjs.org/package/@stdlib/complex-base
156
155
 
157
- [test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.2.0
158
- [test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.2.0
156
+ [test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.3.0
157
+ [test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.3.0
159
158
 
160
159
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-base/main.svg
161
160
  [coverage-url]: https://codecov.io/github/stdlib-js/complex-base?branch=main
@@ -189,8 +188,6 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
189
188
 
190
189
  <!-- <toc-links> -->
191
190
 
192
- [@stdlib/complex/base/assert]: https://www.npmjs.com/package/@stdlib/complex-base-assert
193
-
194
191
  [@stdlib/complex/base/cast-return]: https://www.npmjs.com/package/@stdlib/complex-base-cast-return
195
192
 
196
193
  [@stdlib/complex/base/wrap-function]: https://www.npmjs.com/package/@stdlib/complex-base-wrap-function
package/dist/index.js CHANGED
@@ -1,3 +1,3 @@
1
- "use strict";var e=require('@stdlib/utils-define-read-only-property/dist'),r={};e(r,"assert",require('@stdlib/complex-base-assert/dist'));e(r,"cast",require('@stdlib/complex-base-cast-return/dist'));e(r,"wrap",require('@stdlib/complex-base-wrap-function/dist'));module.exports=r;
1
+ "use strict";var e=require('@stdlib/utils-define-read-only-property/dist'),r={};e(r,"cast",require('@stdlib/complex-base-cast-return/dist'));e(r,"wrap",require('@stdlib/complex-base-wrap-function/dist'));module.exports=r;
2
2
  /** @license Apache-2.0 */
3
3
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../lib/index.js"],
4
- "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/*\n* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-read-only-property' );\n\n\n// MAIN //\n\n/**\n* Top-level namespace.\n*\n* @namespace ns\n*/\nvar ns = {};\n\n/**\n* @name assert\n* @memberof ns\n* @readonly\n* @type {Namespace}\n* @see {@link module:@stdlib/complex/base/assert}\n*/\nsetReadOnly( ns, 'assert', require( '@stdlib/complex-base-assert' ) );\n\n/**\n* @name cast\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/cast-return}\n*/\nsetReadOnly( ns, 'cast', require( '@stdlib/complex-base-cast-return' ) );\n\n/**\n* @name wrap\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/wrap-function}\n*/\nsetReadOnly( ns, 'wrap', require( '@stdlib/complex-base-wrap-function' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
5
- "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,SAAU,QAAS,6BAA8B,CAAE,EASpED,EAAaC,EAAI,OAAQ,QAAS,kCAAmC,CAAE,EASvED,EAAaC,EAAI,OAAQ,QAAS,oCAAqC,CAAE,EAKzE,OAAO,QAAUA",
4
+ "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/*\n* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-read-only-property' );\n\n\n// MAIN //\n\n/**\n* Top-level namespace.\n*\n* @namespace ns\n*/\nvar ns = {};\n\n/**\n* @name cast\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/cast-return}\n*/\nsetReadOnly( ns, 'cast', require( '@stdlib/complex-base-cast-return' ) );\n\n/**\n* @name wrap\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/wrap-function}\n*/\nsetReadOnly( ns, 'wrap', require( '@stdlib/complex-base-wrap-function' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
5
+ "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,OAAQ,QAAS,kCAAmC,CAAE,EASvED,EAAaC,EAAI,OAAQ,QAAS,oCAAqC,CAAE,EAKzE,OAAO,QAAUA",
6
6
  "names": ["setReadOnly", "ns"]
7
7
  }
package/docs/types/index.d.ts CHANGED
@@ -20,7 +20,6 @@
20
20
 
21
21
  /* eslint-disable max-lines */
22
22
 
23
- import assert = require( '@stdlib/complex-base-assert' );
24
23
  import cast = require( '@stdlib/complex-base-cast-return' );
25
24
  import wrap = require( '@stdlib/complex-base-wrap-function' );
26
25
 
@@ -28,11 +27,6 @@ import wrap = require( '@stdlib/complex-base-wrap-function' );
28
27
  * Interface describing the `base` namespace.
29
28
  */
30
29
  interface Namespace {
31
- /**
32
- * Base complex number assert functions.
33
- */
34
- assert: typeof assert;
35
-
36
30
  /**
37
31
  * Wraps an n-ary function and casts a function's return value to a complex number.
38
32
  *
@@ -48,9 +42,9 @@ interface Namespace {
48
42
  * @returns wrapped function
49
43
  *
50
44
  * @example
51
- * var Complex64 = require( '@stdlib/complex-float32' );
52
- * var realf = require( '@stdlib/complex-realf' );
53
- * var imagf = require( '@stdlib/complex-imagf' );
45
+ * var Complex64 = require( '@stdlib/complex-float32-ctor' );
46
+ * var realf = require( '@stdlib/complex-float32-real' );
47
+ * var imagf = require( '@stdlib/complex-float32-imag' );
54
48
  *
55
49
  * function add( x, y, z, w, v, t ) {
56
50
  * return x + y + z + w + v + t;
@@ -86,9 +80,9 @@ interface Namespace {
86
80
  * @returns wrapped function
87
81
  *
88
82
  * @example
89
- * var Complex64 = require( '@stdlib/complex-float32' );
90
- * var realf = require( '@stdlib/complex-realf' );
91
- * var imagf = require( '@stdlib/complex-imagf' );
83
+ * var Complex64 = require( '@stdlib/complex-float32-ctor' );
84
+ * var realf = require( '@stdlib/complex-float32-real' );
85
+ * var imagf = require( '@stdlib/complex-float32-imag' );
92
86
  *
93
87
  * function add( x, y, z, w, v, t ) {
94
88
  * var re = realf( x ) + realf( y ) + realf( z ) + realf( w ) + realf( v ) + realf( t );
package/lib/index.js CHANGED
@@ -36,15 +36,6 @@ var setReadOnly = require( '@stdlib/utils-define-read-only-property' );
36
36
  */
37
37
  var ns = {};
38
38
 
39
- /**
40
- * @name assert
41
- * @memberof ns
42
- * @readonly
43
- * @type {Namespace}
44
- * @see {@link module:@stdlib/complex/base/assert}
45
- */
46
- setReadOnly( ns, 'assert', require( '@stdlib/complex-base-assert' ) );
47
-
48
39
  /**
49
40
  * @name cast
50
41
  * @memberof ns
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/complex-base",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Base (i.e., lower-level) complex number functions.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -16,17 +16,11 @@
16
16
  "main": "lib/index.js",
17
17
  "directories": {
18
18
  "doc": "./docs",
19
- "example": "./examples",
20
19
  "lib": "./lib",
21
- "test": "./test"
20
+ "dist": "./dist"
22
21
  },
23
22
  "types": "./docs/types",
24
- "scripts": {
25
- "test": "make test",
26
- "test-cov": "make test-cov",
27
- "examples": "make examples",
28
- "benchmark": "make benchmark"
29
- },
23
+ "scripts": {},
30
24
  "homepage": "https://stdlib.io",
31
25
  "repository": {
32
26
  "type": "git",
@@ -36,49 +30,11 @@
36
30
  "url": "https://github.com/stdlib-js/stdlib/issues"
37
31
  },
38
32
  "dependencies": {
39
- "@stdlib/complex-base-assert": "^0.2.0",
40
- "@stdlib/complex-base-cast-return": "^0.2.0",
41
- "@stdlib/complex-base-wrap-function": "^0.2.0",
42
- "@stdlib/utils-define-read-only-property": "^0.2.0"
43
- },
44
- "devDependencies": {
45
- "@stdlib/assert-is-boolean": "^0.1.1",
46
- "@stdlib/assert-is-function": "^0.1.1",
47
- "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
48
- "@stdlib/complex-base-assert-is-equal": "^0.2.0",
49
- "@stdlib/complex-base-assert-is-equalf": "^0.2.0",
50
- "@stdlib/complex-base-assert-is-not-equal": "^0.2.0",
51
- "@stdlib/complex-base-assert-is-not-equalf": "^0.2.0",
52
- "@stdlib/complex-base-assert-is-same-value": "^0.2.0",
53
- "@stdlib/complex-base-assert-is-same-value-zero": "^0.3.0",
54
- "@stdlib/complex-base-assert-is-same-value-zerof": "^0.2.0",
55
- "@stdlib/complex-base-assert-is-same-valuef": "^0.1.0",
56
- "@stdlib/complex-float32": "^0.1.1",
57
- "@stdlib/complex-float64": "^0.1.1",
58
- "@stdlib/complex-imagf": "^0.1.1",
59
- "@stdlib/complex-realf": "^0.1.1",
60
- "@stdlib/complex-reim": "^0.2.0",
61
- "@stdlib/complex-reimf": "^0.2.0",
62
- "@stdlib/constants-float32-ninf": "^0.1.1",
63
- "@stdlib/constants-float32-pinf": "^0.1.1",
64
- "@stdlib/constants-float64-ninf": "^0.1.1",
65
- "@stdlib/constants-float64-pinf": "^0.1.1",
66
- "@stdlib/math-base-assert-is-nanf": "^0.1.1",
67
- "@stdlib/math-base-ops-addf": "^0.1.0",
68
- "@stdlib/math-base-ops-caddf": "^0.1.0",
69
- "@stdlib/number-float32-base-assert-is-same-value": "^0.2.0",
70
- "@stdlib/number-float32-base-assert-is-same-value-zero": "^0.2.0",
71
- "@stdlib/number-float64-base-assert-is-same-value": "^0.2.0",
72
- "@stdlib/number-float64-base-assert-is-same-value-zero": "^0.2.0",
73
- "@stdlib/random-base-randu": "^0.1.0",
74
- "@stdlib/string-format": "^0.2.0",
75
- "@stdlib/utils-keys": "^0.1.0",
76
- "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
77
- "istanbul": "^0.4.1",
78
- "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
79
- "@stdlib/bench-harness": "^0.2.0",
80
- "@stdlib/bench": "^0.3.1"
33
+ "@stdlib/complex-base-cast-return": "^0.2.1",
34
+ "@stdlib/complex-base-wrap-function": "^0.2.1",
35
+ "@stdlib/utils-define-read-only-property": "^0.2.2"
81
36
  },
37
+ "devDependencies": {},
82
38
  "engines": {
83
39
  "node": ">=0.10.0",
84
40
  "npm": ">2.7.0"