feat: add blas/ext/base/ndarray/caxpby

lib/node_modules/@stdlib/blas/ext/base/ndarray/caxpby/README.md

@@ -0,0 +1,153 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# caxpby
+
+> Multiply a one-dimensional single-precision complex floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision complex floating-point ndarray multiplied by a scalar constant.
+
+<section class="intro">
+
+This BLAS extension implements the operation
+
+<!-- <equation class="equation" label="eq:axpby" align="center" raw="\mathbf{y} = \alpha \mathbf{x} + \beta \mathbf{y}" alt="Equation for axpby operation."> -->
+
+```math
+\mathbf{y} = \alpha \mathbf{x} + \beta \mathbf{y}
+```
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var caxpby = require( '@stdlib/blas/ext/base/ndarray/caxpby' );
+```
+
+#### caxpby( arrays )
+
+Multiplies a one-dimensional single-precision complex floating-point ndarray by a scalar constant and adds the result to a second one-dimensional single-precision complex floating-point ndarray multiplied by a scalar constant.
+
+```javascript
+var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+
+var x = new Complex64Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
+var y = new Complex64Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );
+
+var alpha = scalar2ndarray( new Complex64( 2.0, 1.0 ), {
+    'dtype': 'complex64'
+});
+
+var beta = scalar2ndarray( new Complex64( 1.0, -1.0 ), {
+    'dtype': 'complex64'
+});
+
+var out = caxpby( [ x, y, alpha, beta ] );
+// returns <ndarray>[ <Complex64>[ 3.0, 4.0 ], <Complex64>[ 9.0, 5.0 ], <Complex64>[ 3.0, -2.0 ] ]
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing the following ndarrays:
+
+    -   a one-dimensional input ndarray.
+    -   a one-dimensional output ndarray.
+    -   a zero-dimensional ndarray containing the constant by which to multiply the input ndarray.
+    -   a zero-dimensional ndarray containing the constant by which to multiply the output ndarray.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The output ndarray is modified **in-place** (i.e., the output ndarray is **mutated**).
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var caxpby = require( '@stdlib/blas/ext/base/ndarray/caxpby' );
+
+var opts = {
+    'dtype': 'float32'
+};
+
+var x = new Complex64Vector( discreteUniform( 20, -100, 100, opts ) );
+console.log( ndarray2array( x ) );
+
+var y = new Complex64Vector( discreteUniform( 20, -100, 100, opts ) );
+console.log( ndarray2array( y ) );
+
+var alpha = scalar2ndarray( new Complex64( 2.0, 1.0 ), {
+    'dtype': 'complex64'
+});
+console.log( 'Alpha:', ndarraylike2scalar( alpha ) );
+
+var beta = scalar2ndarray( new Complex64( 1.0, -1.0 ), {
+    'dtype': 'complex64'
+});
+console.log( 'Beta:', ndarraylike2scalar( beta ) );
+
+caxpby( [ x, y, alpha, beta ] );
+console.log( ndarray2array( y ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/caxpby/benchmark/benchmark.js

@@ -0,0 +1,121 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var caxpby = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'complex64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - ndarray length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var alpha;
+	var beta;
+	var xbuf;
+	var ybuf;
+	var x;
+	var y;
+
+	xbuf = uniform( len*2, -100.0, 100.0, {
+		'dtype': 'float32'
+	});
+	ybuf = uniform( len*2, -100.0, 100.0, {
+		'dtype': 'float32'
+	});
+	x = new Complex64Vector( xbuf.buffer );
+	y = new Complex64Vector( ybuf.buffer );
+	alpha = scalar2ndarray( new Complex64( 2.0, 1.0 ), options );
+	beta = scalar2ndarray( new Complex64( 1.0, -1.0 ), options );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = caxpby( [ x, y, alpha, beta ] );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/ndarray/caxpby/docs/repl.txt

@@ -0,0 +1,42 @@
+
+{{alias}}( arrays )
+    Multiplies a one-dimensional single-precision complex floating-point ndarray
+    by a scalar constant and adds the result to a second one-dimensional single-
+    precision complex floating-point ndarray multiplied by a scalar constant.
+
+    The output ndarray is modified *in-place* (i.e., the output ndarray is
+    *mutated*).
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing the following ndarrays:
+
+        - a one-dimensional input ndarray.
+        - a one-dimensional output ndarray.
+        - a zero-dimensional ndarray containing the constant by which to
+        multiply the input ndarray.
+        - a zero-dimensional ndarray containing the constant by which to
+        multiply the output ndarray.
+
+    Returns
+    -------
+    out: ndarray
+        Output ndarray.
+
+    Examples
+    --------
+    > var bufX = [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ];
+    > var bufY = [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ];
+    > var x = new {{alias:@stdlib/ndarray/vector/complex64}}( bufX );
+    > var y = new {{alias:@stdlib/ndarray/vector/complex64}}( bufY );
+    > var opts = { 'dtype': 'complex64' };
+    > var a = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 1.0 );
+    > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( a, opts );
+    > var b = new {{alias:@stdlib/complex/float32/ctor}}( 1.0, -1.0 );
+    > var beta = {{alias:@stdlib/ndarray/from-scalar}}( b, opts );
+    > {{alias}}( [ x, y, alpha, beta ] )
+    <ndarray>[ <Complex64>[ 3, 4 ], <Complex64>[ 9, 5 ], <Complex64>[ 3, -2 ] ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/blas/ext/base/ndarray/caxpby/docs/types/index.d.ts

@@ -0,0 +1,65 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { complex64ndarray, typedndarray } from '@stdlib/types/ndarray';
+import { Complex64 } from '@stdlib/types/complex';
+
+/**
+* Multiplies a one-dimensional single-precision complex floating-point ndarray by a scalar constant and adds the result to a second one-dimensional single-precision complex floating-point ndarray multiplied by a scalar constant.
+*
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   a one-dimensional input ndarray.
+*     -   a one-dimensional output ndarray.
+*     -   a zero-dimensional ndarray containing the constant by which to multiply the input ndarray.
+*     -   a zero-dimensional ndarray containing the constant by which to multiply the output ndarray.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns output ndarray
+*
+* @example
+* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+*
+* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
+* var y = new Complex64Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );
+*
+* var alpha = scalar2ndarray( new Complex64( 2.0, 1.0 ), {
+*     'dtype': 'complex64'
+* });
+*
+* var beta = scalar2ndarray( new Complex64( 1.0, -1.0 ), {
+*     'dtype': 'complex64'
+* });
+*
+* var out = caxpby( [ x, y, alpha, beta ] );
+* // returns <ndarray>[ <Complex64>[ 3.0, 4.0 ], <Complex64>[ 9.0, 5.0 ], <Complex64>[ 3.0, -2.0 ] ]
+*/
+declare function caxpby( arrays: [ complex64ndarray, complex64ndarray, typedndarray<Complex64>, typedndarray<Complex64> ] ): complex64ndarray;
+
+
+// EXPORTS //
+
+export = caxpby;