added JSDoc comment

Author: gkbishnoi07

lib/node_modules/@stdlib/stats/base/variancewd/lib/accessors.js

@@ -18,6 +18,8 @@
 
 'use strict';
 
+// MAIN //
+
 /**
 * Computes the variance of a strided array using Welford's algorithm and accessors.
 *
@@ -43,8 +45,7 @@
 * var v = variancewd( x.data.length, 1, x, 1, 0 );
 * // returns 10.0
 */
-
-function variancewd(N, correction, x, strideX, offsetX) {
+function variancewd( N, correction, x, strideX, offsetX ) {
 	var delta2;
 	var delta;
 	var xbuf;
@@ -57,24 +58,26 @@ function variancewd(N, correction, x, strideX, offsetX) {
 	var i;
 
 	n = N - correction;
-	if (N <= 0 || n <= 0.0) {
+	if ( N <= 0 || n <= 0.0 ) {
 		return NaN;
 	}
-	if (N === 1 || strideX === 0) {
+	if ( N === 1 || strideX === 0 ) {
 		return 0.0;
 	}
 
+	// Cache reference to array data:
 	xbuf = x.data;
-	get = x.accessors[0];
+	// Cache a reference to the element accessor:
+	get = x.accessors[ 0 ];
 
 	ix = offsetX;
 	M2 = 0.0;
 	mu = 0.0;
 
-	for (i = 0; i < N; i++) {
-		v = get(xbuf, ix);
+	for ( i = 0; i < N; i++ ) {
+		v = get( xbuf, ix );
 		delta = v - mu;
-		mu += delta / (i + 1);
+		mu += delta / ( i + 1 );
 		delta2 = v - mu;
 		M2 += delta * delta2;
 		ix += strideX;
@@ -83,9 +86,5 @@ function variancewd(N, correction, x, strideX, offsetX) {
 	return M2 / n;
 }
 
-/**
-* Exports function for computing the variance of a strided array using Welford's algorithm and accessors.
-*
-* @type {Function}
-*/
+// EXPORTS //
 module.exports = variancewd;