feat: add lapack/base/dlartv

lib/node_modules/@stdlib/lapack/base/dlartv/README.md

@@ -0,0 +1,259 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# dlartv
+
+> Apply a vector of real plane rotations to elements of real vectors `X` and `Y`.
+
+<section class = "usage">
+
+## Usage
+
+```javascript
+var dlartv = require( '@stdlib/lapack/base/dlartv' );
+```
+
+#### dlartv( N, X, strideX, Y, strideY, C, S, strideCS )
+
+Applies a vector of real plane rotations to elements of real vectors `X` and `Y`.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var X = new Float64Array( [ 1.0, 1.0 ] );
+var Y = new Float64Array( [ 1.0, 1.0 ] );
+var C = new Float64Array( [ 1.0, 1.0 ] );
+var S = new Float64Array( [ 0.0, 0.0 ] );
+
+X = dlartv( 2, X, 1, Y, 1, C, S, 1 );
+// X => <Float64Array>[ 1.0, 1.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of plane rotations to apply.
+-   **X**: input [`Float64Array`][mdn-float64array].
+-   **strideX**: stride length for `X`.
+-   **Y**: input [`Float64Array`][mdn-float64array].
+-   **strideY**: stride length for `Y`.
+-   **C**: input [`Float64Array`][mdn-float64array] containing the cosine values of the plane rotations.
+-   **S**: input [`Float64Array`][mdn-float64array] containing the sine values of the plane rotations.
+-   **strideCS**: stride length for `C` and `S`.
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial arrays...
+var X0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
+var Y0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
+var C0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
+var S0 = new Float64Array( [ 0.0, 0.0, 0.0 ] );
+
+// Create offset views...
+var X1 = new Float64Array( X0.buffer, X0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var Y1 = new Float64Array( Y0.buffer, Y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var C1 = new Float64Array( C0.buffer, C0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var S1 = new Float64Array( S0.buffer, S0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+X1 = dlartv( 2, X1, 1, Y1, 1, C1, S1, 1 );
+// X0 => <Float64Array>[ 0.0, 1.0, 1.0 ]
+```
+
+#### dlartv.ndarray( N, X, sx, ox, Y, sy, oy, C, sc, oc, S, ss, os )
+
+Applies a vector of real plane rotations to elements of real vectors `X` and `Y` using alternative semantic indexing.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var X = new Float64Array( [ 1.0, 1.0 ] );
+var Y = new Float64Array( [ 1.0, 1.0 ] );
+var C = new Float64Array( [ 1.0, 1.0 ] );
+var S = new Float64Array( [ 0.0, 0.0 ] );
+
+X = dlartv.ndarray( 2, X, 1, 0, Y, 1, 0, C, 1, 0, S, 1, 0 );
+// X => <Float64Array>[ 1.0, 1.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of plane rotations to apply.
+-   **X**: input [`Float64Array`][mdn-float64array].
+-   **sx**: stride length for `X`.
+-   **ox**: starting index for `X`.
+-   **Y**: input [`Float64Array`][mdn-float64array].
+-   **sy**: stride length for `Y`.
+-   **oy**: starting index for `Y`.
+-   **C**: input [`Float64Array`][mdn-float64array] containing the cosine values of the plane rotations.
+-   **sc**: stride length for `C`.
+-   **oc**: starting index for `C`.
+-   **S**: input [`Float64Array`][mdn-float64array] containing the sine values of the plane rotations.
+-   **ss**: stride length for `S`.
+-   **os**: starting index for `S`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var X = new Float64Array( [ 1.0, 1.0 ] );
+var Y = new Float64Array( [ 1.0, 1.0 ] );
+var C = new Float64Array( [ 1.0, 1.0 ] );
+var S = new Float64Array( [ 0.5, 0.4 ] );
+
+X = dlartv.ndarray( 2, X, -1, 1, Y, 1, 0, C, 1, 0, S, 1, 0 );
+// X => <Float64Array>[ 1.4, 1.5 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `dlartv()` corresponds to the [LAPACK][lapack] routine [`dlartv`][lapack-dlartv].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var dlartv = require( '@stdlib/lapack/base/dlartv' );
+
+var X = new Float64Array( [ 1.0, 1.0 ] );
+var Y = new Float64Array( [ 1.0, 1.0 ] );
+var C = new Float64Array( [ 1.0, 1.0 ] );
+var S = new Float64Array( [ 0.5, 0.5 ] );
+
+X = dlartv( 2, X, 1, Y, 1, C, S, 1 );
+console.log( X );
+console.log( Y );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+TODO
+```
+
+#### TODO
+
+TODO.
+
+```c
+TODO
+```
+
+TODO
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- 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">
+
+[lapack]: https://www.netlib.org/lapack/explore-html/
+
+[lapack-dlartv]: https://www.netlib.org/lapack/explore-html/df/d2e/group__lartv_ga7b74ad84d2c14b74df63690c5af1ce21.html#ga7b74ad84d2c14b74df63690c5af1ce21
+
+[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/lapack/base/dlartv/benchmark/benchmark.js

@@ -0,0 +1,101 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var pkg = require( './../package.json' ).name;
+var dlartv = require( './../lib/dlartv.js' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var X = uniform( len, -10.0, 10.0, options );
+	var Y = uniform( len, -10.0, 10.0, options );
+	var C = uniform( len, -1.0, 1.0, options );
+	var S = uniform( len, -1.0, 1.0, options );
+
+	return benchmark;
+
+	function benchmark( b ) {
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			X = uniform( len, -10.0, 10.0, options );
+			Y = uniform( len, -10.0, 10.0, options );
+			X = dlartv( len, X, 1, Y, 1, C, S, 1 );
+			if ( isnan( X[ i%X.length ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( X[ i%X.length ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		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( pkg+':len='+len, f );
+	}
+}
+
+main();