@stdlib/complex-base 0.2.1 → 0.4.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -68,8 +68,9 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
--   <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base complex number assert functions.</span>
+-   <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) complex number assertion functions.</span>
 -   <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>
+-   <span class="signature">[`parse( str )`][@stdlib/complex/base/parse]</span><span class="delimiter">: </span><span class="description">parses a string representing a complex number into a complex like object `{re: number, im: number}`.</span>
 -   <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>
 
 </div>
@@ -141,7 +142,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -154,8 +155,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/complex-base.svg
 [npm-url]: https://npmjs.org/package/@stdlib/complex-base
 
-[test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.4.0
+[test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.4.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-base/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/complex-base?branch=main
@@ -167,8 +168,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -193,6 +194,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/complex/base/cast-return]: https://www.npmjs.com/package/@stdlib/complex-base-cast-return
 
+[@stdlib/complex/base/parse]: https://www.npmjs.com/package/@stdlib/complex-base-parse
+
 [@stdlib/complex/base/wrap-function]: https://www.npmjs.com/package/@stdlib/complex-base-wrap-function
 
 <!-- </toc-links> -->

package/dist/index.js

@@ -1,3 +1,3 @@
-"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;
+"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,"parse",require('@stdlib/complex-base-parse/dist'));e(r,"wrap",require('@stdlib/complex-base-wrap-function/dist'));module.exports=r;
 /** @license Apache-2.0 */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../lib/index.js"],
-  "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"],
-  "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",
+  "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 parse\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/parse}\n*/\nsetReadOnly( ns, 'parse', require( '@stdlib/complex-base-parse' ) );\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"],
+  "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,QAAS,QAAS,4BAA6B,CAAE,EASlED,EAAaC,EAAI,OAAQ,QAAS,oCAAqC,CAAE,EAKzE,OAAO,QAAUA",
   "names": ["setReadOnly", "ns"]
 }

package/docs/types/index.d.ts

@@ -22,6 +22,7 @@
 
 import assert = require( '@stdlib/complex-base-assert' );
 import cast = require( '@stdlib/complex-base-cast-return' );
+import parse = require( '@stdlib/complex-base-parse' );
 import wrap = require( '@stdlib/complex-base-wrap-function' );
 
 /**
@@ -29,7 +30,7 @@ import wrap = require( '@stdlib/complex-base-wrap-function' );
 */
 interface Namespace {
 	/**
-	* Base complex number assert functions.
+	* Base (i.e., lower-level) complex number assertion functions.
 	*/
 	assert: typeof assert;
 
@@ -48,9 +49,7 @@ interface Namespace {
 	* @returns wrapped function
 	*
 	* @example
-	* var Complex64 = require( '@stdlib/complex-float32' );
-	* var realf = require( '@stdlib/complex-realf' );
-	* var imagf = require( '@stdlib/complex-imagf' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
 	*
 	* function add( x, y, z, w, v, t ) {
 	*     return x + y + z + w + v + t;
@@ -61,15 +60,23 @@ interface Namespace {
 	* // ...
 	*
 	* var z = f( 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 );
-	* // returns <Complex64>
+	* // returns <Complex64>[ 33.0, 0.0 ]
+	*/
+	cast: typeof cast;
+
+	/**
+	* Parses a string representing a complex number into a complex like object.
 	*
-	* var re = realf( z );
-	* // returns 33.0
+	* @param str - input string
+	* @returns complex like object
 	*
-	* var im = imagf( z );
-	* // returns 0.0
+	* @example
+	* var str = '4 + 6i';
+	*
+	* var z = ns.parse( str );
+	* // returns { 're' : 4, 'im' : 6 }
 	*/
-	cast: typeof cast;
+	parse: typeof parse;
 
 	/**
 	* Wraps an n-ary function accepting complex number arguments to support providing both real and complex numbers.
@@ -86,9 +93,9 @@ interface Namespace {
 	* @returns wrapped function
 	*
 	* @example
-	* var Complex64 = require( '@stdlib/complex-float32' );
-	* var realf = require( '@stdlib/complex-realf' );
-	* var imagf = require( '@stdlib/complex-imagf' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	* var realf = require( '@stdlib/complex-float32-real' );
+	* var imagf = require( '@stdlib/complex-float32-imag' );
 	*
 	* function add( x, y, z, w, v, t ) {
 	*     var re = realf( x ) + realf( y ) + realf( z ) + realf( w ) + realf( v ) + realf( t );

package/lib/index.js

@@ -54,6 +54,15 @@ setReadOnly( ns, 'assert', require( '@stdlib/complex-base-assert' ) );
 */
 setReadOnly( ns, 'cast', require( '@stdlib/complex-base-cast-return' ) );
 
+/**
+* @name parse
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/base/parse}
+*/
+setReadOnly( ns, 'parse', require( '@stdlib/complex-base-parse' ) );
+
 /**
 * @name wrap
 * @memberof ns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/complex-base",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Base (i.e., lower-level) complex number functions.",
   "license": "Apache-2.0",
   "author": {
@@ -31,9 +31,10 @@
   },
   "dependencies": {
     "@stdlib/complex-base-assert": "^0.2.1",
-    "@stdlib/complex-base-cast-return": "^0.2.1",
-    "@stdlib/complex-base-wrap-function": "^0.2.1",
-    "@stdlib/utils-define-read-only-property": "^0.2.1"
+    "@stdlib/complex-base-cast-return": "^0.2.2",
+    "@stdlib/complex-base-parse": "^0.1.1",
+    "@stdlib/complex-base-wrap-function": "^0.2.2",
+    "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {