feat: add lapack/base/dlapy2

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

@@ -0,0 +1,173 @@
+<!--
+
+@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.
+
+-->
+
+# dlapy2
+
+> LAPACK routine to calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
+```
+
+#### dlapy2( x, y )
+
+Calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
+
+```javascript
+var out = dlapy2( 3.0, 4.0 );
+// returns 5.0
+```
+
+The function has the following parameters:
+
+-   **x**: input number.
+-   **y**: input number.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `dlapy2()` corresponds to the [LAPACK][LAPACK] function [`dlapy2`][lapack-dlapy2].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
+
+var opts = {
+    'dtype': 'float64'
+};
+var x = discreteUniform( 100, -50, 50, opts );
+var y = discreteUniform( 100, -50, 50, opts );
+
+logEachMap( 'dlapy2( %d, %d ) = %0.4f', x, y, dlapy2 );
+```
+
+</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-dlapy2]: https://www.netlib.org/lapack/explore-html-3.6.1/d7/d43/group__aux_o_t_h_e_rauxiliary_gacf4c47c2f593fb3a4e842bca6df1240b.html
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,56 @@
+/**
+* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var pkg = require( './../package.json' ).name;
+var dlapy2 = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var len;
+	var x;
+	var y;
+	var z;
+	var i;
+
+	len = 100;
+	x = uniform( len, -50, 50 );
+	y = uniform( len, -50, 50 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = dlapy2( x[ i % len ], y[ i % len ] );
+		if ( isnan( z ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( z ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/lapack/base/dlapy2/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( x, y )
+    Returns sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary
+    overflow.
+
+    If either argument is `NaN` and the other argument is not `+-Infinity`,
+    the function returns `NaN`.
+
+    Parameters
+    ----------
+    x: number
+        First number.
+
+    y: number
+        Second number.
+
+    Returns
+    -------
+    out: number
+        Sqrt( x^2 + y^2 ).
+
+    Examples
+    --------
+    > var h = {{alias}}( -5.0, 12.0 )
+    13.0
+    > h = {{alias}}( NaN, 12.0 )
+    NaN
+    > h = {{alias}}( -0.0, -0.0 )
+    0.0
+
+    See Also
+    --------

lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/index.d.ts

@@ -0,0 +1,45 @@
+/*
+* @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
+
+/**
+* LAPACK routine to calculate sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary overflow.
+*
+* @param x - number
+* @param y - number
+* @returns sqrt( x^2 + y^2 )
+*
+* @example
+* var h = dlapy2( -5.0, 12.0 );
+* // returns 13.0
+*
+* @example
+* var h = dlapy2( NaN, 12.0 );
+* // returns NaN
+*
+* @example
+* var h = dlapy2( -0.0, -0.0 );
+* // returns 0.0
+*/
+declare function dlapy2( x: number, y: number ): number;
+
+
+// EXPORTS //
+
+export = dlapy2;

lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/test.ts

@@ -0,0 +1,56 @@
+/*
+* @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.
+*/
+
+import dlapy2 = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	dlapy2( 8, 2 ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided values other than two numbers...
+{
+	dlapy2( true, 3 ); // $ExpectError
+	dlapy2( false, 2 ); // $ExpectError
+	dlapy2( '5', 1 ); // $ExpectError
+	dlapy2( [], 1 ); // $ExpectError
+	dlapy2( {}, 2 ); // $ExpectError
+	dlapy2( ( x: number ): number => x, 2 ); // $ExpectError
+
+	dlapy2( 9, true ); // $ExpectError
+	dlapy2( 9, false ); // $ExpectError
+	dlapy2( 5, '5' ); // $ExpectError
+	dlapy2( 8, [] ); // $ExpectError
+	dlapy2( 9, {} ); // $ExpectError
+	dlapy2( 8, ( x: number ): number => x ); // $ExpectError
+
+	dlapy2( [], true ); // $ExpectError
+	dlapy2( {}, false ); // $ExpectError
+	dlapy2( false, '5' ); // $ExpectError
+	dlapy2( {}, [] ); // $ExpectError
+	dlapy2( '5', ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	dlapy2(); // $ExpectError
+	dlapy2( 3 ); // $ExpectError
+}

lib/node_modules/@stdlib/lapack/base/dlapy2/examples/index.js

@@ -0,0 +1,31 @@
+/**
+* @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';
+
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var dlapy2 = require( './../lib' );
+
+var opts = {
+	'dtype': 'float64'
+};
+var x = discreteUniform( 100, -50, 50, opts );
+var y = discreteUniform( 100, -50, 50, opts );
+
+logEachMap( 'dlapy2( %d, %d ) = %0.4f', x, y, dlapy2 );