@stdlib/complex-float32-base 0.1.0 → 0.2.0

package/NOTICE

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

package/README.md

@@ -81,7 +81,11 @@ The namespace contains the following functions:
 <div class="namespace-toc">
 
 -   <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float32/base/add]</span><span class="delimiter">: </span><span class="description">add two single-precision complex floating-point numbers.</span>
+-   <span class="signature">[`identity( z )`][@stdlib/complex/float32/base/identity]</span><span class="delimiter">: </span><span class="description">evaluate the identity function of a single-precision complex floating-point number.</span>
 -   <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision complex floating-point numbers.</span>
+-   <span class="signature">[`neg( z )`][@stdlib/complex/float32/base/neg]</span><span class="delimiter">: </span><span class="description">negate a single-precision complex floating-point number.</span>
+-   <span class="signature">[`scale( alpha, c )`][@stdlib/complex/float32/base/scale]</span><span class="delimiter">: </span><span class="description">scale a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.</span>
+-   <span class="signature">[`sub( z1, z2 )`][@stdlib/complex/float32/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
 
 </div>
 
@@ -152,7 +156,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>
 
@@ -165,8 +169,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/complex-float32-base.svg
 [npm-url]: https://npmjs.org/package/@stdlib/complex-float32-base
 
-[test-image]: https://github.com/stdlib-js/complex-float32-base/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/complex-float32-base/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/complex-float32-base/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/complex-float32-base/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-float32-base/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/complex-float32-base?branch=main
@@ -178,8 +182,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
 
@@ -202,8 +206,16 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/complex/float32/base/add]: https://www.npmjs.com/package/@stdlib/complex-float32-base-add
 
+[@stdlib/complex/float32/base/identity]: https://www.npmjs.com/package/@stdlib/complex-float32-base-identity
+
 [@stdlib/complex/float32/base/mul]: https://www.npmjs.com/package/@stdlib/complex-float32-base-mul
 
+[@stdlib/complex/float32/base/neg]: https://www.npmjs.com/package/@stdlib/complex-float32-base-neg
+
+[@stdlib/complex/float32/base/scale]: https://www.npmjs.com/package/@stdlib/complex-float32-base-scale
+
+[@stdlib/complex/float32/base/sub]: https://www.npmjs.com/package/@stdlib/complex-float32-base-sub
+
 [@stdlib/complex/float32/base/assert]: https://www.npmjs.com/package/@stdlib/complex-float32-base-assert
 
 <!-- </toc-links> -->

package/dist/index.js

@@ -1,3 +1,3 @@
-"use strict";var r=require('@stdlib/utils-define-read-only-property/dist'),e={};r(e,"add",require('@stdlib/complex-float32-base-add/dist'));r(e,"assert",require('@stdlib/complex-float32-base-assert/dist'));r(e,"mul",require('@stdlib/complex-float32-base-mul/dist'));module.exports=e;
+"use strict";var r=require('@stdlib/utils-define-read-only-property/dist'),e={};r(e,"add",require('@stdlib/complex-float32-base-add/dist'));r(e,"assert",require('@stdlib/complex-float32-base-assert/dist'));r(e,"identity",require('@stdlib/complex-float32-base-identity/dist'));r(e,"mul",require('@stdlib/complex-float32-base-mul/dist'));r(e,"neg",require('@stdlib/complex-float32-base-neg/dist'));r(e,"scale",require('@stdlib/complex-float32-base-scale/dist'));r(e,"sub",require('@stdlib/complex-float32-base-sub/dist'));module.exports=e;
 /** @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) 2024 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 add\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/add}\n*/\nsetReadOnly( ns, 'add', require( '@stdlib/complex-float32-base-add' ) );\n\n/**\n* @name assert\n* @memberof ns\n* @readonly\n* @type {Namespace}\n* @see {@link module:@stdlib/complex/float32/base/assert}\n*/\nsetReadOnly( ns, 'assert', require( '@stdlib/complex-float32-base-assert' ) );\n\n/**\n* @name mul\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/mul}\n*/\nsetReadOnly( ns, 'mul', require( '@stdlib/complex-float32-base-mul' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
-  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAStED,EAAaC,EAAI,SAAU,QAAS,qCAAsC,CAAE,EAS5ED,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAKtE,OAAO,QAAUA",
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 add\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/add}\n*/\nsetReadOnly( ns, 'add', require( '@stdlib/complex-float32-base-add' ) );\n\n/**\n* @name assert\n* @memberof ns\n* @readonly\n* @type {Namespace}\n* @see {@link module:@stdlib/complex/float32/base/assert}\n*/\nsetReadOnly( ns, 'assert', require( '@stdlib/complex-float32-base-assert' ) );\n\n/**\n* @name identity\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/identity}\n*/\nsetReadOnly( ns, 'identity', require( '@stdlib/complex-float32-base-identity' ) );\n\n/**\n* @name mul\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/mul}\n*/\nsetReadOnly( ns, 'mul', require( '@stdlib/complex-float32-base-mul' ) );\n\n/**\n* @name neg\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/neg}\n*/\nsetReadOnly( ns, 'neg', require( '@stdlib/complex-float32-base-neg' ) );\n\n/**\n* @name scale\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/scale}\n*/\nsetReadOnly( ns, 'scale', require( '@stdlib/complex-float32-base-scale' ) );\n\n/**\n* @name sub\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/float32/base/sub}\n*/\nsetReadOnly( ns, 'sub', require( '@stdlib/complex-float32-base-sub' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
+  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAStED,EAAaC,EAAI,SAAU,QAAS,qCAAsC,CAAE,EAS5ED,EAAaC,EAAI,WAAY,QAAS,uCAAwC,CAAE,EAShFD,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAStED,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAStED,EAAaC,EAAI,QAAS,QAAS,oCAAqC,CAAE,EAS1ED,EAAaC,EAAI,MAAO,QAAS,kCAAmC,CAAE,EAKtE,OAAO,QAAUA",
   "names": ["setReadOnly", "ns"]
 }

package/docs/types/index.d.ts

@@ -22,7 +22,11 @@
 
 import add = require( '@stdlib/complex-float32-base-add' );
 import assert = require( '@stdlib/complex-float32-base-assert' );
+import identity = require( '@stdlib/complex-float32-base-identity' );
 import mul = require( '@stdlib/complex-float32-base-mul' );
+import neg = require( '@stdlib/complex-float32-base-neg' );
+import scale = require( '@stdlib/complex-float32-base-scale' );
+import sub = require( '@stdlib/complex-float32-base-sub' );
 
 /**
 * Interface describing the `base` namespace.
@@ -37,20 +41,30 @@ interface Namespace {
 	*
 	* @example
 	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
-	* var realf = require( '@stdlib/complex-float32-real' );
-	* var imagf = require( '@stdlib/complex-float32-imag' );
 	*
 	* var z = new Complex64( 5.0, 3.0 );
-	* // returns <Complex64>
 	*
 	* var out = ns.add( z, z );
-	* // returns <Complex64>
+	* // returns <Complex64>[ 10.0, 6.0 ]
 	*
-	* var re = realf( out );
-	* // returns 10.0
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var out = new Float32Array( 2 );
+	* var v = ns.add.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
+	* // returns <Float32Array>[ 10.0, 6.0 ]
+	*
+	* var bool = ( out === v );
+	* // returns true
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
 	*
-	* var im = imagf( out );
-	* // returns 6.0
+	* var z1 = new Float32Array( [ 5.0, 3.0 ] );
+	* var z2 = new Float32Array( [ 5.0, 3.0 ] );
+	*
+	* var out = ns.add.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
+	* // returns <Float32Array>[ 10.0, 6.0 ]
 	*/
 	add: typeof add;
 
@@ -59,6 +73,20 @@ interface Namespace {
 	*/
 	assert: typeof assert;
 
+	/**
+	* Evaluates the identity function for single-precision complex floating-point number.
+	*
+	* @param z - input value
+	* @returns input value
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var v = ns.identity( new Complex64( -1.0, 2.0 ) );
+	* // returns <Complex64>[ -1.0, 2.0 ]
+	*/
+	identity: typeof identity;
+
 	/**
 	* Multiplies two single-precision complex floating-point numbers.
 	*
@@ -68,25 +96,118 @@ interface Namespace {
 	*
 	* @example
 	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
-	* var realf = require( '@stdlib/complex-float32-real' );
-	* var imagf = require( '@stdlib/complex-float32-imag' );
 	*
 	* var z1 = new Complex64( 5.0, 3.0 );
-	* // returns <Complex64>
-	*
 	* var z2 = new Complex64( -2.0, 1.0 );
-	* // returns <Complex64>
 	*
 	* var out = ns.mul( z1, z2 );
-	* // returns <Complex64>
+	* // returns <Complex64>[ -13.0, -1.0 ]
 	*
-	* var re = realf( out );
-	* // returns -13.0
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var out = new Float32Array( 2 );
+	* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
+	* // returns <Float32Array>[ -13.0, -1.0 ]
 	*
-	* var im = imagf( out );
-	* // returns -1.0
+	* var bool = ( out === v );
+	* // returns true
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var z1 = new Float32Array( [ 5.0, 3.0 ] );
+	* var z2 = new Float32Array( [ -2.0, 1.0 ] );
+	*
+	* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
+	* // returns <Float32Array>[ -13.0, -1.0 ]
 	*/
 	mul: typeof mul;
+
+	/**
+	* Negates a single-precision complex floating-point number.
+	*
+	* @param z - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z = new Complex64( -4.2, 5.5 );
+	*
+	* var out = ns.neg( z );
+	* // returns <Complex64>[ ~4.2, -5.5 ]
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z = new Complex64( 0.0, 0.0 );
+	*
+	* var out = ns.neg( z );
+	* // returns <Complex64>[ -0.0, -0.0 ]
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z = new Complex64( NaN, NaN );
+	*
+	* var out = ns.neg( z );
+	* // returns <Complex64>[ NaN, NaN ]
+	*/
+	neg: typeof neg;
+
+	/**
+	* Scales a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.
+	*
+	* @param alpha - scalar constant
+	* @param z - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z = new Complex64( 5.0, 3.0 );
+	*
+	* var out = ns.scale( 5.0, z );
+	* // returns <Complex64>[ 25.0, 15.0 ]
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var out = new Float32Array( 2 );
+	* var v = ns.scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
+	* // returns <Float32Array>[ 25.0, 15.0 ]
+	*
+	* var bool = ( out === v );
+	* // returns true
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var z = new Float32Array( [ 5.0, 3.0 ] );
+	*
+	* var out = ns.scale.strided( 5.0, z, 1, 0, new Float32Array( 2 ), 1, 0 );
+	* // returns <Float32Array>[ 25.0, 15.0 ]
+	*/
+	scale: typeof scale;
+
+	/**
+	* Subtracts two single-precision complex floating-point numbers.
+	*
+	* @param z1 - complex number
+	* @param z2 - complex number
+	* @returns result
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z1 = new Complex64( 5.0, 3.0 );
+	* var z2 = new Complex64( -2.0, 1.0 );
+	*
+	* var out = ns.sub( z1, z2 );
+	* // returns <Complex64>[ 7.0, 2.0 ]
+	*/
+	sub: typeof sub;
 }
 
 /**

package/lib/index.js

@@ -54,6 +54,15 @@ setReadOnly( ns, 'add', require( '@stdlib/complex-float32-base-add' ) );
 */
 setReadOnly( ns, 'assert', require( '@stdlib/complex-float32-base-assert' ) );
 
+/**
+* @name identity
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/base/identity}
+*/
+setReadOnly( ns, 'identity', require( '@stdlib/complex-float32-base-identity' ) );
+
 /**
 * @name mul
 * @memberof ns
@@ -63,6 +72,33 @@ setReadOnly( ns, 'assert', require( '@stdlib/complex-float32-base-assert' ) );
 */
 setReadOnly( ns, 'mul', require( '@stdlib/complex-float32-base-mul' ) );
 
+/**
+* @name neg
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/base/neg}
+*/
+setReadOnly( ns, 'neg', require( '@stdlib/complex-float32-base-neg' ) );
+
+/**
+* @name scale
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/base/scale}
+*/
+setReadOnly( ns, 'scale', require( '@stdlib/complex-float32-base-scale' ) );
+
+/**
+* @name sub
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/base/sub}
+*/
+setReadOnly( ns, 'sub', require( '@stdlib/complex-float32-base-sub' ) );
+
 
 // EXPORTS //
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/complex-float32-base",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Base (i.e., lower-level) single-precision complex number functions.",
   "license": "Apache-2.0",
   "author": {
@@ -30,9 +30,13 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/complex-float32-base-add": "^0.1.0",
+    "@stdlib/complex-float32-base-add": "^0.2.0",
     "@stdlib/complex-float32-base-assert": "^0.1.1",
-    "@stdlib/complex-float32-base-mul": "^0.1.0",
+    "@stdlib/complex-float32-base-identity": "^0.1.0",
+    "@stdlib/complex-float32-base-mul": "^0.2.0",
+    "@stdlib/complex-float32-base-neg": "^0.1.0",
+    "@stdlib/complex-float32-base-scale": "^0.1.0",
+    "@stdlib/complex-float32-base-sub": "^0.1.0",
     "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},