Skip to content

Commit 56f1b9b

Browse files
authored
docs: update parameter type and add keyword
PR-URL: #12729 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent dd5048f commit 56f1b9b

5 files changed

Lines changed: 5 additions & 4 deletions

File tree

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/dcorrelation.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var ndarray = require( './ndarray.js' );
2929
/**
3030
* Computes the correlation distance between two double-precision floating-point strided arrays.
3131
*
32-
* @param {PositiveInteger} N - number of indexed elements
32+
* @param {NonNegativeInteger} N - number of indexed elements
3333
* @param {Float64Array} x - first input array
3434
* @param {integer} strideX - stride length of `x`
3535
* @param {Float64Array} y - second input array

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/dcorrelation.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' );
2828
/**
2929
* Computes the correlation distance between two double-precision floating-point strided arrays.
3030
*
31-
* @param {PositiveInteger} N - number of indexed elements
31+
* @param {NonNegativeInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array
3333
* @param {integer} strideX - stride length of `x`
3434
* @param {Float64Array} y - second input array

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/ndarray.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var dpcorr = require( '@stdlib/stats/strided/dpcorr' ).ndarray;
2828
/**
2929
* Computes the correlation distance between two double-precision floating-point strided arrays using alternative indexing semantics.
3030
*
31-
* @param {PositiveInteger} N - number of indexed elements
31+
* @param {NonNegativeInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array
3333
* @param {integer} strideX - stride length of `x`
3434
* @param {NonNegativeInteger} offsetX - starting index of `x`

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/ndarray.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' );
2828
/**
2929
* Computes the correlation distance between two double-precision floating-point strided arrays using alternative indexing semantics.
3030
*
31-
* @param {PositiveInteger} N - number of indexed elements
31+
* @param {NonNegativeInteger} N - number of indexed elements
3232
* @param {Float64Array} x - first input array
3333
* @param {integer} strideX - stride length of `x`
3434
* @param {NonNegativeInteger} offsetX - starting index of `x`

lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
"dcorrelation",
6363
"correlation",
6464
"distance",
65+
"metric",
6566
"strided",
6667
"strided array",
6768
"typed",

0 commit comments

Comments
 (0)