feat: add lapack/base/dlapy3

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

@@ -0,0 +1,175 @@
+<!--
+
+@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.
+
+-->
+
+# dlapy3
+
+> LAPACK routine to calculate `sqrt(x^2 + y^2 + z^2)` in a manner which doesn't cause unnecessary overflow.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dlapy3 = require( '@stdlib/lapack/base/dlapy3' );
+```
+
+#### dlapy3( x, y, z )
+
+Computes `sqrt(x^2 + y^2 + z^2)` in a manner which doesn't cause unnecessary overflow.
+
+```javascript
+var out = dlapy3( 3.0, 4.0, 12.0 );
+// returns 13.0
+```
+
+The function has the following parameters:
+
+-   **x**: first input number.
+-   **y**: second input number.
+-   **z**: third input number.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `dlapy3()` corresponds to the [LAPACK][LAPACK] function [`dlapy3`][lapack-dlapy3].
+
+</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 dlapy3 = require( '@stdlib/lapack/base/dlapy3' );
+
+var opts = {
+    'dtype': 'float64'
+};
+var x = discreteUniform( 100, -50, 50, opts );
+var y = discreteUniform( 100, -50, 50, opts );
+var z = discreteUniform( 100, -50, 50, opts );
+
+logEachMap( 'dlapy3( %d, %d, %d ) = %0.4f', x, y, z, dlapy3 );
+```
+
+</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-dlapy3]: https://netlib.org/lapack/explore-html/d3/dba/group__lapy3_ga7ba5106d26a131c0d1ac7fa7ca3904b7.html
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,58 @@
+/**
+* @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 dlapy3 = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var len;
+	var t;
+	var x;
+	var y;
+	var z;
+	var i;
+
+	len = 100;
+	x = uniform( len, -50, 50 );
+	y = uniform( len, -50, 50 );
+	z = uniform( len, -50, 50 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		t = dlapy3( x[ i % len ], y[ i % len ], z[ i % len ] );
+		if ( isnan( t ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( t ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

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

@@ -0,0 +1,30 @@
+
+{{alias}}( x, y, z )
+    Computes `sqrt(x^2 + y^2 + z^2)` in a manner which doesn't cause
+    unnecessary overflow.
+
+    Parameters
+    ----------
+    x: number
+        First input number.
+
+    y: number
+        Second input number.
+
+    z: number
+        Third input number.
+
+    Returns
+    -------
+    out: number
+        Square root of sum of squares.
+
+    Examples
+    --------
+    > var h = {{alias}}( 3.0, 4.0, 12.0 )
+    13.0
+    > h = {{alias}}( -0.0, -0.0, 0.0 )
+    0.0
+
+    See Also
+    --------

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

@@ -0,0 +1,42 @@
+/*
+* @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 + z^2)` in a manner which doesn't cause unnecessary overflow.
+*
+* @param x - first input number
+* @param y - second input number
+* @param z - third input number
+* @returns `sqrt(x^2 + y^2 + z^2)`
+*
+* @example
+* var h = dlapy3( 3.0, 4.0, 12.0 );
+* // returns 13.0
+*
+* @example
+* var h = dlapy3( -0.0, -0.0, 0.0 );
+* // returns 0.0
+*/
+declare function dlapy3( x: number, y: number, z: number ): number;
+
+
+// EXPORTS //
+
+export = dlapy3;

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

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