-
-
Notifications
You must be signed in to change notification settings - Fork 870
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
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
924df55
feat: add lapack/base/dlapy2
aayush0325 6ac3ace
feat: add examples tests benchmarks
aayush0325 32864bc
docs: add docs fodler
aayush0325 6ea246d
docs: add README
aayush0325 feaeb70
chore: cleanup
aayush0325 febba4f
chore: cleanup
aayush0325 5cdd8fd
docs: fix missing decimal
kgryte 765de9c
chore: code review
aayush0325 e2ccfaa
chore: code review
aayush0325 c17e21d
Apply suggestions from code review
kgryte 3fe16d3
docs: remove annotation
kgryte 26c9b6d
test: add `NaN` tests
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
commit 32864bcb689e5d6e73a9931c2ac850b8ee886a3e
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. | ||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Parameters | ||
---------- | ||
x: number | ||
First number. | ||
|
||
y: number | ||
Second number. | ||
|
||
Returns | ||
------- | ||
out: number | ||
Sqrt( x^2 + y^2 ). | ||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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
45
lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/index.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 ) | ||
aayush0325 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* | ||
* @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
56
lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.