Skip to content

Commit 5be6315

Browse files
committed
fix: update 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: na - 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 2f015ca commit 5be6315

File tree

1 file changed

+5
-5
lines changed
  • lib/node_modules/@stdlib/stats/base/nanstdevyc

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Computes the [standard deviation][standard-deviation] of a strided array ignorin
146146
```javascript
147147
var x = [ 1.0, -2.0, NaN, 2.0 ];
148148

149-
var v = nanstdevyc.ndarray( 4, 1, x, 1, 0 );
149+
var v = nanstdevyc.ndarray( x.length, 1, x, 1, 0 );
150150
// returns ~2.0817
151151
```
152152

@@ -157,9 +157,9 @@ The function has the following additional parameters:
157157
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [standard deviation][standard-deviation] for every other element in `x` starting from the second element
158158

159159
```javascript
160-
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
160+
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];
161161

162-
var v = nanstdevyc.ndarray( 4, 1, x, 2, 1 );
162+
var v = nanstdevyc.ndarray( 5, 1, x, 2, 1 );
163163
// returns 2.5
164164
```
165165

@@ -252,6 +252,8 @@ console.log( v );
252252

253253
[@youngs:1971a]: https://doi.org/10.1080/00401706.1971.10488826
254254

255+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
256+
255257
<!-- <related-links> -->
256258

257259
[@stdlib/stats/strided/dnanstdevyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanstdevyc
@@ -264,8 +266,6 @@ console.log( v );
264266

265267
[@stdlib/stats/base/stdevyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/stdevyc
266268

267-
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
268-
269269
<!-- </related-links> -->
270270

271271
</section>

0 commit comments

Comments
 (0)