Skip to content

Commit 0fae247

Browse files
authored
Update index.d.ts
Signed-off-by: Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>
1 parent be50f23 commit 0fae247

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/stats/base/ndarray/dcovarmtk/docs/types

1 file changed

+1
-1
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import { float64ndarray } from '@stdlib/types/ndarray';
3636
* - a zero-dimensional ndarray specifying 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 covariance according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the population covariance, setting this parameter to `0` is the standard choice (i.e., the provided arrays contain data constituting entire populations). When computing the unbiased sample covariance, setting this parameter to `1` is the standard choice (i.e., the provided arrays contain data sampled from larger populations; this is commonly referred to as Bessel's correction).
3737
*
3838
* @param arrays - array-like object containing input ndarrays
39-
* @returns maximum value
39+
* @returns covariance
4040
*
4141
* @example
4242
* var Float64Array = require( '@stdlib/array/float64' );

0 commit comments

Comments
 (0)