feat: add blas/base/drotmg

lib/node_modules/@stdlib/blas/base/drotmg/README.md

@@ -0,0 +1,119 @@
+<!--
+
+@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.
+
+-->
+
+# drotmg
+
+> Constructs the parameters for a modified Givens plane rotation.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var drotmg = require( '@stdlib/blas/base/drotmg' );
+```
+
+#### drotmg( d1, d2, x1, y1 )
+
+Constructs a Givens plane rotation provided four double-precision floating-point values `d1`, `d2`, `x1` and `y1`.
+
+```javascript
+var out = drotmg( 3.0, 4.0, 1.5, 2.5 );
+// returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+```
+
+The function has the following parameters:
+
+-   **d1**: scaling factor for the first vector component.
+-   **d2**: scaling factor for the second vector component.
+-   **x1**: first component of the first vector.
+-   **y1**: first component of the second vector.
+
+#### drotmg.assign( d1, d2, x1, y1, out, stride, offset )
+
+Constructs a Givens plane rotation provided four double-precision floating-point values `d1`, `d2`, `x1` and `y1` and assigns results to an output array.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var out = new Float64Array( 5 );
+
+var y = drotmg.assign( 3.0, 4.0, 1.5, 2.5, out, 1, 0 );
+// returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+
+var bool = ( y === out );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `drotmg()` corresponds to the [BLAS][blas] level 1 function [`drotmg`][drotmg].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var drotmg = require( '@stdlib/blas/base/drotmg' );
+
+var param;
+var i;
+for ( i = 0; i < 100; i++ ) {
+    d1 = discreteUniform( -5, 5 );
+    d2 = discreteUniform( -5, 5 );
+    x1 = discreteUniform( -5, 5 );
+    y1 = discreteUniform( -5, 5 );
+    param = drotmg( d1, d2, x1, y1 );
+    console.log( param );
+}
+```
+
+</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">
+
+[blas]: http://www.netlib.org/blas
+
+[drotmg]: https://netlib.org/lapack/explore-html-3.6.1/de/da4/group__double__blas__level1_ga13e351a3dfafa2cd8dc5302dcf53f69a.html
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/base/drotmg/benchmark/benchmark.js

@@ -0,0 +1,96 @@
+/**
+* @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' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nanf' );
+var Float64Array = require( '@stdlib/array/float64' );
+var pkg = require( './../package.json' ).name;
+var drotmg = require( './../lib' );
+
+
+// VARIABLES //
+
+var OPTS = {
+	'dtype': 'float64'
+};
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var param;
+	var d1;
+	var d2;
+	var x1;
+	var y1;
+	var i;
+
+	d1 = discreteUniform( 100, -5, 5, OPTS );
+	d2 = discreteUniform( 100, -5, 5, OPTS );
+	x1 = discreteUniform( 100, -5, 5, OPTS );
+	y1 = discreteUniform( 100, -5, 5, OPTS );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		param = drotmg( d1[ i%d1.length ], d2[ i%d2.length ], x1[ i%x1.length ], y1[ i%y1.length ] );
+		if ( isnan( param[ i%5 ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( param[ i%5 ] ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':assign', function benchmark( b ) {
+	var param;
+	var d1;
+	var d2;
+	var x1;
+	var y1;
+	var z;
+	var i;
+
+	d1 = discreteUniform( 100, -5, 5, OPTS );
+	d2 = discreteUniform( 100, -5, 5, OPTS );
+	x1 = discreteUniform( 100, -5, 5, OPTS );
+	y1 = discreteUniform( 100, -5, 5, OPTS );
+	param = new Float64Array( 5 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = drotmg.assign( d1[ i%d1.length ], d2[ i%d2.length ], x1[ i%x1.length ], y1[ i%y1.length ], param, 1, 0 );
+		if ( typeof z !=='object' ) {
+			b.fail( 'should return an array' );
+		}
+	}
+	b.toc();
+	if ( isnan( z[ i%5 ] ) ) {
+		b.fail( 'should return the output array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/blas/base/drotmg/docs/repl.txt

@@ -0,0 +1,73 @@
+
+{{alias}}( d1, d2, x1, y1 )
+    Constructs the parameters for a modified Givens plane rotation from four
+    double-precision floating-point numbers.
+
+    Parameters
+    ----------
+    d1: float
+        Scaling factor for the first vector component.
+
+    d2: float
+        Scaling factor for the second vector component.
+
+    x1: float
+        First component of the first vector.
+
+    y1: float
+        First component of the second vector.
+
+    Returns
+    -------
+    out: Float64Array
+        Computed values.
+
+    Examples
+    --------
+    > var out = {{alias}}( 3.0, 4.0, 1.5, 2.5 )
+    <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+
+
+{{alias}}.assign( d1, d2, x1, y1, out, stride, offset )
+    Constructs the parameters for a modified Givens plane rotation from four
+    double-precision floating-point numbers and assigns the results to an
+    output array.
+
+    Parameters
+    ----------
+    d1: float
+        Scaling factor for the first vector component.
+
+    d2: float
+        Scaling factor for the second vector component.
+
+    x1: float
+        First component of the first vector.
+
+    y1: float
+        First component of the second vector.
+
+    out: Float64Array
+        Output array.
+
+    stride: integer
+        Output array stride.
+
+    offset: integer
+        Output array index offset.
+
+    Returns
+    -------
+    out: Float64Array
+        Output array.
+
+    Examples
+    --------
+    > var out = new {{alias:@stdlib/array/float64}}( 5 );
+    > var y = {{alias}}.assign( 3.0, 4.0, 1.5, 2.5, out, 1, 0 )
+    <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+    > var bool = ( y === out )
+    true
+
+    See Also
+    --------

lib/node_modules/@stdlib/blas/base/drotmg/docs/types/index.d.ts

@@ -0,0 +1,100 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Inteface describing `drotmg`.
+*/
+interface Routine {
+	/**
+	* Constructs the parameters for a modified Givens plane rotation.
+	*
+	* @param d1 - scaling factor for the first vector component
+	* @param d2 - scaling factor for the second vector component
+	* @param x1 - first component of the first vector
+	* @param y1 - first component of the second vector
+	* @returns - output array containing the rotation parameters
+	*
+	* @example
+	* var out = drotmg( 3.0, 4.0, 1.5, 2.5 );
+	* // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+	*
+	* @example
+	* var out = drotmg( 3.0, 5.0, 1.0, 2.0 );
+	* // returns <Float64Array>[ 1.0, 0.3, 0.0, 0.0, 0.5 ]
+	*/
+	( d1: number, d2: number, x1: number, y1: number ): Float64Array;
+
+	/**
+	* Constructs the parameters for a modified Givens plane rotation.
+	*
+	* @param d1 - scaling factor for the first vector component
+	* @param d2 - scaling factor for the second vector component
+	* @param x1 - first component of the first vector
+	* @param y1 - first component of the second vector
+	* @param out - output array
+	* @param stride - index increment
+	* @param offset - starting index
+	* @returns - output array containing the rotation parameters
+	*
+	* @example
+	* var Float64Array = require( '@stdlib/array/float64' );
+	*
+	* var out = new Float64Array( 5 );
+	*
+	* var y = drotmg.assign( 3.0, 4.0, 1.5, 2.5, out, 1, 0  );
+	* // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+	*
+	* var bool = (y === out);
+	* // returns true
+	*/
+	assign( d1: number, d2: number, x1: number, y1: number, out: Float64Array, stride: number, offset: number ): Float64Array;
+}
+
+/**
+* Constructs the parameters for a modified Givens plane rotation.
+*
+* @param d1 - scaling factor for the first vector component
+* @param d2 - scaling factor for the second vector component
+* @param x1 - first component of the first vector
+* @param y1 - first component of the second vector
+* @param out - output array
+* @param stride - index increment
+* @param offset - starting index
+* @returns - output array containing the rotation parameters
+*
+* @example
+* var out = drotmg( 3.0, 4.0, 1.5, 2.5 );
+* // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
+* var out = new Float64Array( 4 );
+* var y = drotg.assign( 3.0, 4.0, 1.5, 2.5 out, 1, 0 );
+* // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ]
+*
+* var bool = (y === out);
+* // returns true
+*/
+declare var drotmg: Routine;
+
+// EXPORTS //
+
+export = drotmg;