Skip to content

Commit b00ece3

Browse files
committed
fix: fixing 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent aec6b5a commit b00ece3

File tree

1 file changed

+2
-2
lines changed
  • lib/node_modules/@stdlib/stats/base/svarianceyc

1 file changed

+2
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,15 @@ The function accepts the following arguments:
251251
- **N**: `[in] CBLAS_INT` number of indexed elements.
252252
- **correction**: `[in] float` degrees of freedom adjustment. Setting this parameter to a value other than 0 has the effect of adjusting the divisor during the calculation of the [variance][variance] according to `N-c` where c corresponds to the provided degrees of freedom adjustment. When computing the [variance][variance] of a population, setting this parameter to 0 is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the unbiased sample [variance][variance], setting this parameter to 1 is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction).
253253
- **x**: `[in] float*` input array.
254-
- **strideX**: stride length for `x`.
254+
- **strideX**: `[in] CBLAS_INT` stride length for `x`.
255255
256256
```c
257257
float stdlib_strided_svarianceyc( const CBLAS_INT N, const float correction, const float *X, const CBLAS_INT strideX );
258258
```
259259

260260
#### stdlib_strided_svarianceyc_ndarray( N, correction, \*X, strideX, offsetX )
261261

262-
Computes the [variance][variance] of a single-precision floating-point strided array using a one-pass algorithm proposed by Youngs and Cramer and alternative indexing semantics.
262+
Computes the [variance][variance] of a single-precision floating-point strided array using a one-pass algorithm proposed by Youngs and Cramer and using alternative indexing semantics.
263263

264264
```c
265265
const float x[] = { 1.0f, -2.0f, 2.0f };

0 commit comments

Comments
 (0)