Skip to content

feat: add lapack/base/dlapy2 #7120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add docs fodler
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
  • Loading branch information
aayush0325 committed May 30, 2025
commit 32864bcb689e5d6e73a9931c2ac850b8ee886a3e
33 changes: 33 additions & 0 deletions lib/node_modules/@stdlib/lapack/base/dlapy2/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

{{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
--------

45 changes: 45 additions & 0 deletions lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -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;
56 changes: 56 additions & 0 deletions lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/test.ts
Original file line number Diff line number Diff line change
@@ -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
}