Skip to content

Commit 7cd152b

Browse files
committed
docs: fix return values and parameters
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 70c0a74 commit 7cd152b

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

lib/node_modules/@stdlib/stats/strided/dcovarmtk/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
111111
var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
112112

113113
var v = dcovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 );
114-
// returns ~7.6667
114+
// returns ~3.8333
115115
```
116116

117117
The function has the following parameters:
@@ -165,7 +165,7 @@ var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
165165
var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
166166

167167
var v = dcovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 );
168-
// returns ~7.6667
168+
// returns ~3.8333
169169
```
170170

171171
The function has the following additional parameters:
@@ -277,7 +277,7 @@ The function accepts the following arguments:
277277
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
278278
279279
```c
280-
double stdlib_strided_dcovarmtk( const CBLAS_INT N, const double correction, const double meanx, const double *X, const CBLAS_INT strideX, const double meanY, const double *Y, const CBLAS_INT strideY );
280+
double stdlib_strided_dcovarmtk( const CBLAS_INT N, const double correction, const double meanx, const double *X, const CBLAS_INT strideX, const double meany, const double *Y, const CBLAS_INT strideY );
281281
```
282282

283283
#### stdlib_strided_dcovarmtk_ndarray( N, correction, meanx, \*X, strideX, offsetX, meany, \*Y, strideY, offsetY )

lib/node_modules/@stdlib/stats/strided/dcovarmtk/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ interface Routine {
4242
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
4343
*
4444
* var v = dcovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 );
45-
* // returns ~7.6667
45+
* // returns ~3.8333
4646
*/
4747
( N: number, correction: number, meanx: number, x: Float64Array, strideX: number, meany: number, y: Float64Array, strideY: number ): number;
4848

@@ -56,7 +56,7 @@ interface Routine {
5656
* @param strideX - stride length of `x`
5757
* @param offsetX - starting index of `x`
5858
* @param meany - mean of `y`
59-
* @param y - first input array
59+
* @param y - second input array
6060
* @param strideY - stride length of `y`
6161
* @param offsetY - starting index of `y`
6262
* @returns covariance
@@ -68,7 +68,7 @@ interface Routine {
6868
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
6969
*
7070
* var v = dcovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 );
71-
* // returns ~7.6667
71+
* // returns ~3.8333
7272
*/
7373
ndarray( N: number, correction: number, meanx: number, x: Float64Array, strideX: number, offsetX: number, meany: number, y: Float64Array, strideY: number, offsetY: number ): number;
7474
}
@@ -93,7 +93,7 @@ interface Routine {
9393
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
9494
*
9595
* var v = dcovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 );
96-
* // returns ~7.6667
96+
* // returns ~3.8333
9797
*
9898
* @example
9999
* var Float64Array = require( '@stdlib/array/float64' );
@@ -102,7 +102,7 @@ interface Routine {
102102
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
103103
*
104104
* var v = dcovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 );
105-
* // returns ~7.6667
105+
* // returns ~3.8333
106106
*/
107107
declare var dcovarmtk: Routine;
108108

0 commit comments

Comments
 (0)