Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -86,7 +86,6 @@ indent_style = tab
 [*.{f,f.txt}]
 indent_style = space
 indent_size = 2
-insert_final_newline = false
 
 # Set properties for shell files:
 [*.{sh,sh.txt}]
@@ -121,7 +120,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]

.github/workflows/test_install.yml

@@ -50,8 +50,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the sequence of job steps...
     steps:

.github/workflows/test_published_package.yml

@@ -47,8 +47,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the job's steps:
     steps:

.gitignore

@@ -188,3 +188,7 @@ jsconfig.json
 # Other editor files #
 ######################
 .idea/
+
+# Cursor #
+##########
+.cursorignore

CHANGELOG.md

@@ -4,14 +4,37 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-15)
+## Unreleased (2025-02-16)
+
+<section class="features">
+
+### Features
+
+-   [`d7154e2`](https://github.com/stdlib-js/stdlib/commit/d7154e2c7756ce51a9bbbf38848960ea988d4ea6) - add `strided` and `assign` APIs to `complex/float32/base/mul` [(#5205)](https://github.com/stdlib-js/stdlib/pull/5205)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#5203](https://github.com/stdlib-js/stdlib/issues/5203)
+
+</section>
+
+<!-- /.issues -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`d7154e2`](https://github.com/stdlib-js/stdlib/commit/d7154e2c7756ce51a9bbbf38848960ea988d4ea6) - **feat:** add `strided` and `assign` APIs to `complex/float32/base/mul` [(#5205)](https://github.com/stdlib-js/stdlib/pull/5205) _(by Shabareesh Shetty, Athan Reines, stdlib-bot)_
 -   [`40308a8`](https://github.com/stdlib-js/stdlib/commit/40308a8953dd480537d4c4359cc6e09f679e3ec1) - **build:** update configurations _(by Athan Reines)_
 
 </details>
@@ -24,9 +47,10 @@
 
 ### Contributors
 
-A total of 1 person contributed to this release. Thank you to this contributor:
+A total of 2 people contributed to this release. Thank you to the following contributors:
 
 -   Athan Reines
+-   Shabareesh Shetty
 
 </section>
 

CONTRIBUTORS

@@ -2,12 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <jain.aadishj@gmail.com>
 Aayush Khanna <aayushiitbhu23@gmail.com>
 Abhijit Raut <abhijitmraut8010@gmail.com>
 Adarsh Palaskar <adarshpalaskar99@gmail.com>
 Aditya Sapra <adityaework@gmail.com>
 Ahmed Atwa <Ahmedatwa866@yahoo.com>
 Ahmed Kashkoush <ahmedkashkoush464@gmail.com>
+Ahmed Khaled <kahmd1444@gmail.com>
 Aleksandr <112382387+alextes90@users.noreply.github.com>
 Ali Salesi <ali_sal1381@yahoo.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
@@ -24,14 +26,21 @@ Dan Rose <danoftheroses@gmail.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
+Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
+Dev Goel <135586571+corsairier@users.noreply.github.com>
+Dhruv Arvind Singh <154677013+DhruvArvindSingh@users.noreply.github.com>
+Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
 Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>
 Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
 EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
 Frank Kovacs <fran70kk@gmail.com>
+GK Bishnoi <gkishan1kyt@gmail.com>
+Gaurav <gaurav70380@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
-Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>
+Gururaj Gurram <gururajgurram1512@gmail.com>
+Harsh <149176984+hrshya@users.noreply.github.com>
 HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
 Harshita Kalani <harshitakalani02@gmail.com>
 Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
@@ -45,22 +54,24 @@ Joey Reed <joeyrreed@gmail.com>
 Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
+Karan Anand <119553199+anandkaranubc@users.noreply.github.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
-Khaldon <kahmd1444@gmail.com>
 Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
-Lovelin <100030865+lovelindhoni@users.noreply.github.com>
+Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 Manik Sharma <maniksharma.rke@gmail.com>
 Manvith M <148960168+manvith2003@users.noreply.github.com>
 Marcus Fantham <mfantham@users.noreply.github.com>
 Matt Cochrane <matthew.cochrane.eng@gmail.com>
 Mihir Pandit <129577900+MSP20086@users.noreply.github.com>
 Milan Raj <rajsite@users.noreply.github.com>
+Mohammad Bin Aftab <48010758+MohammadBinAftab@users.noreply.github.com>
 Mohammad Kaif <mdkaifprofession@gmail.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Naveen Kumar <stupiddint@gmail.com>
 Neeraj Pathak <neerajrpathak710@gmail.com>
 Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
@@ -71,10 +82,11 @@ Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <goswami.4@iitj.ac.in>
-Praneki <97080887+PraneGIT@users.noreply.github.com>
-Pratik <97464067+Pratik772846@users.noreply.github.com>
+Pranjal Jha <97080887+PraneGIT@users.noreply.github.com>
+Prashant Kumar Yadav <144602492+0PrashantYadav0@users.noreply.github.com>
+Pratik Singh <97464067+Pratik772846@users.noreply.github.com>
 Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
-Priyansh <88396544+itsspriyansh@users.noreply.github.com>
+Priyansh Prajapati <88396544+itsspriyansh@users.noreply.github.com>
 Priyanshu Agarwal <113460573+AgPriyanshu18@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
 Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
@@ -93,7 +105,7 @@ Sarthak Paandey <145528240+SarthakPaandey@users.noreply.github.com>
 Saurabh Singh <saurabhsraghuvanshi@gmail.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
-Shivam <11shivam00@gmail.com>
+Shivam Ahir <11shivam00@gmail.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
 Shubham Mishra <shubh622005@gmail.com>
@@ -112,11 +124,12 @@ UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
-Vivek maurya <155618190+vivekmaurya001@users.noreply.github.com>
+Vivek Maurya <vm8118134@gmail.com>
 Xiaochuan Ye <tap91624@gmail.com>
 Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
-naveen <stupiddint@gmail.com>
+ekambains <bainsinbusiness@gmail.com>
 olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
+pranav-1720 <123018993+pranav-1720@users.noreply.github.com>
 rainn <88160429+AmCodesLame@users.noreply.github.com>
 rei2hu <reimu@reimu.ws>

NOTICE

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

README.md

@@ -91,6 +91,61 @@ var im = imagf( v );
 // returns -1.0
 ```
 
+#### mul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )
+
+Multiplies two single-precision complex floating-point numbers and assigns results to a provided output array.
+
+```javascript
+var Float32Array = require( '@stdlib/array-float32' );
+
+var out = new Float32Array( 2 );
+var v = mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
+// returns <Float32Array>[ -13.0, -1.0 ]
+
+var bool = ( out === v );
+// returns true
+```
+
+The function supports the following parameters:
+
+-   **re1**: real component of the first complex number.
+-   **im1**: imaginary component of the first complex number.
+-   **re2**: real component of the second complex number.
+-   **im2**: imaginary component of the second complex number.
+-   **out**: output array.
+-   **strideOut**: stride length for `out`.
+-   **offsetOut**: starting index for `out`.
+
+#### mul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )
+
+Multiplies two single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.
+
+```javascript
+var Float32Array = require( '@stdlib/array-float32' );
+
+var z1 = new Float32Array( [ 5.0, 3.0 ] );
+var z2 = new Float32Array( [ -2.0, 1.0 ] );
+var out = new Float32Array( 2 );
+
+var v = mul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 );
+// returns <Float32Array>[ -13.0, -1.0 ]
+
+var bool = ( out === v );
+// returns true
+```
+
+The function supports the following parameters:
+
+-   **z1**: first complex number strided array view.
+-   **sz1**: stride length for `z1`.
+-   **oz1**: starting index for `z1`.
+-   **z2**: second complex number strided array view.
+-   **sz2**: stride length for `z2`.
+-   **oz2**: starting index for `z2`.
+-   **out**: output array.
+-   **so**: stride length for `out`.
+-   **oo**: starting index for `out`.
+
 </section>
 
 <!-- /.usage -->
@@ -279,7 +334,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

benchmark/benchmark.assign.js

@@ -0,0 +1,70 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench-harness' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var Float32Array = require( '@stdlib/array-float32' );
+var pkg = require( './../package.json' ).name;
+var mul = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
+// MAIN //
+
+bench( pkg+':assign', function benchmark( b ) {
+	var out;
+	var re;
+	var im;
+	var N;
+	var i;
+	var j;
+	var k;
+
+	N = 100;
+	re = uniform( N, -500.0, 500.0, options );
+	im = uniform( N, -500.0, 500.0, options );
+
+	out = new Float32Array( 2 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		j = i % N;
+		k = ( i+1 ) % N;
+		out = mul.assign( re[ j ], im[ j ], re[ k ], im[ k ], out, 1, 0 );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( isnanf( out[ 0 ] ) || isnanf( out[ 1 ] ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});