Skip to content

Commit c1fafe5

Browse files
aayush0325aayush0325
committed
refactor: update paths
Ref: #4797 --- 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: na - task: lint_javascript_src status: passed - 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 f795dd3 commit c1fafe5

File tree

7 files changed

+17
-17
lines changed

7 files changed

+17
-17
lines changed

‎lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/d.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2034,7 +2034,7 @@ ns.push({
20342034
'@stdlib/stats/strided/dnanstdevtk',
20352035
'@stdlib/stats/base/dstdev',
20362036
'@stdlib/stats/strided/dvariancetk',
2037-
'@stdlib/stats/base/sstdevtk',
2037+
'@stdlib/stats/strided/sstdevtk',
20382038
'@stdlib/stats/base/stdevtk'
20392039
]
20402040
});

‎lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/s.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -1261,7 +1261,7 @@ ns.push({
12611261
'@stdlib/stats/base/nanstdevtk',
12621262
'@stdlib/stats/base/snanstdev',
12631263
'@stdlib/stats/base/snanvariancetk',
1264-
'@stdlib/stats/base/sstdevtk'
1264+
'@stdlib/stats/strided/sstdevtk'
12651265
]
12661266
});
12671267

@@ -1658,8 +1658,8 @@ ns.push({
16581658

16591659
ns.push({
16601660
'alias': 'base.strided.sstdevtk',
1661-
'path': '@stdlib/stats/base/sstdevtk',
1662-
'value': require( '@stdlib/stats/base/sstdevtk' ),
1661+
'path': '@stdlib/stats/strided/sstdevtk',
1662+
'value': require( '@stdlib/stats/strided/sstdevtk' ),
16631663
'type': 'Function',
16641664
'related': [
16651665
'@stdlib/stats/strided/dstdevtk',
@@ -1838,7 +1838,7 @@ ns.push({
18381838
'related': [
18391839
'@stdlib/stats/strided/dstdevtk',
18401840
'@stdlib/stats/base/nanstdevtk',
1841-
'@stdlib/stats/base/sstdevtk',
1841+
'@stdlib/stats/strided/sstdevtk',
18421842
'@stdlib/stats/base/stdev',
18431843
'@stdlib/stats/base/variancetk'
18441844
]
@@ -1941,7 +1941,7 @@ ns.push({
19411941
'related': [
19421942
'@stdlib/stats/strided/dvariancetk',
19431943
'@stdlib/stats/base/snanvariancetk',
1944-
'@stdlib/stats/base/sstdevtk',
1944+
'@stdlib/stats/strided/sstdevtk',
19451945
'@stdlib/stats/base/svariance',
19461946
'@stdlib/stats/base/variancetk'
19471947
]

‎lib/node_modules/@stdlib/stats/base/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ The namespace contains the following statistical functions:
228228
- <span class="signature">[`sstdev( N, correction, x, stride )`][@stdlib/stats/base/sstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array.</span>
229229
- <span class="signature">[`sstdevch( N, correction, x, strideX )`][@stdlib/stats/strided/sstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass trial mean algorithm.</span>
230230
- <span class="signature">[`sstdevpn( N, correction, x, strideX )`][@stdlib/stats/strided/sstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a two-pass algorithm.</span>
231-
- <span class="signature">[`sstdevtk( N, correction, x, strideX )`][@stdlib/stats/base/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
231+
- <span class="signature">[`sstdevtk( N, correction, x, strideX )`][@stdlib/stats/strided/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
232232
- <span class="signature">[`sstdevwd( N, correction, x, stride )`][@stdlib/stats/base/sstdevwd]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using Welford's algorithm.</span>
233233
- <span class="signature">[`sstdevyc( N, correction, x, strideX )`][@stdlib/stats/base/sstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass algorithm proposed by Youngs and Cramer.</span>
234234
- <span class="signature">[`stdev( N, correction, x, stride )`][@stdlib/stats/base/stdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array.</span>
@@ -641,7 +641,7 @@ console.log( objectKeys( ns ) );
641641

642642
[@stdlib/stats/strided/sstdevpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevpn
643643

644-
[@stdlib/stats/base/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevtk
644+
[@stdlib/stats/strided/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevtk
645645

646646
[@stdlib/stats/base/sstdevwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevwd
647647

‎lib/node_modules/@stdlib/stats/base/snanstdevtk/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ console.log( v );
247247
- <span class="package-name">[`@stdlib/stats/base/nanstdevtk`][@stdlib/stats/base/nanstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a one-pass textbook algorithm.</span>
248248
- <span class="package-name">[`@stdlib/stats/base/snanstdev`][@stdlib/stats/base/snanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values.</span>
249249
- <span class="package-name">[`@stdlib/stats/base/snanvariancetk`][@stdlib/stats/base/snanvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a one-pass textbook algorithm.</span>
250-
- <span class="package-name">[`@stdlib/stats/base/sstdevtk`][@stdlib/stats/base/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
250+
- <span class="package-name">[`@stdlib/stats/strided/sstdevtk`][@stdlib/stats/strided/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
251251

252252
</section>
253253

@@ -275,7 +275,7 @@ console.log( v );
275275

276276
[@stdlib/stats/base/snanvariancetk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanvariancetk
277277

278-
[@stdlib/stats/base/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevtk
278+
[@stdlib/stats/strided/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevtk
279279

280280
<!-- </related-links> -->
281281

‎lib/node_modules/@stdlib/stats/base/stdevtk/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ var v = stdevtk.ndarray( N, 1, x, 2, 1 );
183183
- If `N <= 0`, both functions return `NaN`.
184184
- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return `NaN`.
185185
- Some caution should be exercised when using the one-pass textbook algorithm. Literature overwhelmingly discourages the algorithm's use for two reasons: 1) the lack of safeguards against underflow and overflow and 2) the risk of catastrophic cancellation when subtracting the two sums if the sums are large and the variance small. These concerns have merit; however, the one-pass textbook algorithm should not be dismissed outright. For data distributions with a moderately large standard deviation to mean ratio (i.e., **coefficient of variation**), the one-pass textbook algorithm may be acceptable, especially when performance is paramount and some precision loss is acceptable (including a risk of computing a negative variance due to floating-point rounding errors!). In short, no single "best" algorithm for computing the standard deviation exists. The "best" algorithm depends on the underlying data distribution, your performance requirements, and your minimum precision requirements. When evaluating which algorithm to use, consider the relative pros and cons, and choose the algorithm which best serves your needs.
186-
- Depending on the environment, the typed versions ([`dstdevtk`][@stdlib/stats/strided/dstdevtk], [`sstdevtk`][@stdlib/stats/base/sstdevtk], etc.) are likely to be significantly more performant.
186+
- Depending on the environment, the typed versions ([`dstdevtk`][@stdlib/stats/strided/dstdevtk], [`sstdevtk`][@stdlib/stats/strided/sstdevtk], etc.) are likely to be significantly more performant.
187187

188188
</section>
189189

@@ -240,7 +240,7 @@ console.log( v );
240240

241241
- <span class="package-name">[`@stdlib/stats/strided/dstdevtk`][@stdlib/stats/strided/dstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array using a one-pass textbook algorithm.</span>
242242
- <span class="package-name">[`@stdlib/stats/base/nanstdevtk`][@stdlib/stats/base/nanstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a one-pass textbook algorithm.</span>
243-
- <span class="package-name">[`@stdlib/stats/base/sstdevtk`][@stdlib/stats/base/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
243+
- <span class="package-name">[`@stdlib/stats/strided/sstdevtk`][@stdlib/stats/strided/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
244244
- <span class="package-name">[`@stdlib/stats/base/stdev`][@stdlib/stats/base/stdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array.</span>
245245
- <span class="package-name">[`@stdlib/stats/base/variancetk`][@stdlib/stats/base/variancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array using a one-pass textbook algorithm.</span>
246246

@@ -266,7 +266,7 @@ console.log( v );
266266

267267
[@stdlib/stats/base/nanstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanstdevtk
268268

269-
[@stdlib/stats/base/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevtk
269+
[@stdlib/stats/strided/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevtk
270270

271271
[@stdlib/stats/base/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/stdev
272272

‎lib/node_modules/@stdlib/stats/base/svariancetk/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ int main( void ) {
381381
382382
- <span class="package-name">[`@stdlib/stats/strided/dvariancetk`][@stdlib/stats/strided/dvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array using a one-pass textbook algorithm.</span>
383383
- <span class="package-name">[`@stdlib/stats/base/snanvariancetk`][@stdlib/stats/base/snanvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a one-pass textbook algorithm.</span>
384-
- <span class="package-name">[`@stdlib/stats/base/sstdevtk`][@stdlib/stats/base/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
384+
- <span class="package-name">[`@stdlib/stats/strided/sstdevtk`][@stdlib/stats/strided/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
385385
- <span class="package-name">[`@stdlib/stats/base/svariance`][@stdlib/stats/base/svariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array.</span>
386386
- <span class="package-name">[`@stdlib/stats/base/variancetk`][@stdlib/stats/base/variancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array using a one-pass textbook algorithm.</span>
387387
@@ -407,7 +407,7 @@ int main( void ) {
407407
408408
[@stdlib/stats/base/snanvariancetk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanvariancetk
409409
410-
[@stdlib/stats/base/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevtk
410+
[@stdlib/stats/strided/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevtk
411411
412412
[@stdlib/stats/base/svariance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/svariance
413413

‎lib/node_modules/@stdlib/stats/strided/dstdevtk/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ int main( void ) {
352352
- <span class="package-name">[`@stdlib/stats/strided/dnanstdevtk`][@stdlib/stats/strided/dnanstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring NaN values and using a one-pass textbook algorithm.</span>
353353
- <span class="package-name">[`@stdlib/stats/base/dstdev`][@stdlib/stats/base/dstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array.</span>
354354
- <span class="package-name">[`@stdlib/stats/strided/dvariancetk`][@stdlib/stats/strided/dvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array using a one-pass textbook algorithm.</span>
355-
- <span class="package-name">[`@stdlib/stats/base/sstdevtk`][@stdlib/stats/base/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
355+
- <span class="package-name">[`@stdlib/stats/strided/sstdevtk`][@stdlib/stats/strided/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass textbook algorithm.</span>
356356
- <span class="package-name">[`@stdlib/stats/base/stdevtk`][@stdlib/stats/base/stdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array using a one-pass textbook algorithm.</span>
357357
358358
</section>
@@ -379,7 +379,7 @@ int main( void ) {
379379
380380
[@stdlib/stats/strided/dvariancetk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dvariancetk
381381
382-
[@stdlib/stats/base/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevtk
382+
[@stdlib/stats/strided/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdevtk
383383
384384
[@stdlib/stats/base/stdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/stdevtk
385385

0 commit comments

Comments
 (0)