Skip to content

Commit 6ea246d

Browse files
aayush0325aayush0325
committed
docs: add README
--- 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: passed - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 32864bc commit 6ea246d

File tree

2 files changed

+173
-1
lines changed

2 files changed

+173
-1
lines changed

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

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# dlapy2
22+
23+
> LAPACK routine to calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
31+
```
32+
33+
#### dlapy2( x, y )
34+
35+
Calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
36+
37+
```javascript
38+
var out = dlapy2( 3.0, 4.0 );
39+
// returns 5.0
40+
```
41+
42+
The function has the following parameters:
43+
44+
- **x**: input number.
45+
- **y**: input number.
46+
47+
</section>
48+
49+
<!-- /.usage -->
50+
51+
<section class="notes">
52+
53+
## Notes
54+
55+
- `dlapy2()` corresponds to the [LAPACK][LAPACK] function [`dlapy2`][lapack-dlapy2].
56+
57+
</section>
58+
59+
<!-- /.notes -->
60+
61+
<section class="examples">
62+
63+
## Examples
64+
65+
<!-- eslint no-undef: "error" -->
66+
67+
```javascript
68+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
69+
var logEachMap = require( '@stdlib/console/log-each-map' );
70+
var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
71+
72+
var opts = {
73+
'dtype': 'float64'
74+
};
75+
var x = discreteUniform( 100, -50, 50, opts );
76+
var y = discreteUniform( 100, -50, 50, opts );
77+
78+
logEachMap( 'dlapy2( %d, %d ) = %0.4f', x, y, dlapy2 );
79+
```
80+
81+
</section>
82+
83+
<!-- /.examples -->
84+
85+
<!-- C interface documentation. -->
86+
87+
* * *
88+
89+
<section class="c">
90+
91+
## C APIs
92+
93+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
94+
95+
<section class="intro">
96+
97+
</section>
98+
99+
<!-- /.intro -->
100+
101+
<!-- C usage documentation. -->
102+
103+
<section class="usage">
104+
105+
### Usage
106+
107+
```c
108+
TODO
109+
```
110+
111+
#### TODO
112+
113+
TODO.
114+
115+
```c
116+
TODO
117+
```
118+
119+
TODO
120+
121+
```c
122+
TODO
123+
```
124+
125+
</section>
126+
127+
<!-- /.usage -->
128+
129+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
130+
131+
<section class="notes">
132+
133+
</section>
134+
135+
<!-- /.notes -->
136+
137+
<!-- C API usage examples. -->
138+
139+
<section class="examples">
140+
141+
### Examples
142+
143+
```c
144+
TODO
145+
```
146+
147+
</section>
148+
149+
<!-- /.examples -->
150+
151+
</section>
152+
153+
<!-- /.c -->
154+
155+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
156+
157+
<section class="related">
158+
159+
</section>
160+
161+
<!-- /.related -->
162+
163+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
164+
165+
<section class="links">
166+
167+
[lapack]: https://www.netlib.org/lapack/explore-html/
168+
169+
[lapack-dlapy2]: https://www.netlib.org/lapack/explore-html-3.6.1/d7/d43/group__aux_o_t_h_e_rauxiliary_gacf4c47c2f593fb3a4e842bca6df1240b.html
170+
171+
</section>
172+
173+
<!-- /.links -->

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,3 @@
3030

3131
See Also
3232
--------
33-

0 commit comments

Comments
 (0)