feat: add lapack/base/dlapy2

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

@@ -0,0 +1,198 @@
+<!--
+
+@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.
+
+-->
+
+# dlapy2
+
+> Return hypotenuse taking care not to cause unnecessary overflow and underflow.
+
+<!-- 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 -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
+```
+
+#### dlapy2( x, y )
+
+Returns hypotenuse taking care not to cause unnecessary overflow and underflow.
+
+```javascript
+var h = dlapy2( -5.0, 12.0 );
+// returns 13.0
+
+h = dlapy2( -0.0, -0.0 );
+// returns +0.0
+```
+
+If either argument is `NaN`, the function returns `NaN`.
+
+```javascript
+var h = dlapy2( NaN, 12.0 );
+// returns NaN
+
+h = dlapy2( 5.0, NaN );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   `dlapy2()` corresponds to the [LAPACK][lapack] function [`dlapy2`][lapack-dlapy2].
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+
+var x;
+var y;
+var h;
+var i;
+
+for ( i = 0; i < 100; i++ ) {
+    x = round( randu()*100.0 ) - 50.0;
+    y = round( randu()*100.0 ) - 50.0;
+    h = dlapy2( x, y );
+    console.log( 'h(%d,%d) = %d', x, y, h );
+}
+```
+
+</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/d8/d5e/group__lapy2_gab55f5b30b6088a4d6ccd9f073aff1eb7.html#gab55f5b30b6088a4d6ccd9f073aff1eb7
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,53 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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 randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pkg = require( './../package.json' ).name;
+var dlapy2 = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var z;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = ( randu()*100.0 ) - 50.0;
+		y = ( randu()*100.0 ) - 50.0;
+		z = dlapy2( x, y );
+		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,31 @@
+
+{{alias}}( x, y )
+    Returns hypotenuse taking care not to cause unnecessary overflow and
+    underflow.
+
+    If either argument is `NaN`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    x: number
+        First number.
+
+    y: number
+        Second number.
+
+    Returns
+    -------
+    out: number
+        Hypotenuse.
+
+    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) 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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Returns hypotenuse taking care not to cause unnecessary overflow and underflow.
+*
+* @param x - number
+* @param y - number
+* @returns hypotenuse
+*
+* @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) 2019 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
+}