feat: add support for accessor arrays and refactor stats/base/stdevyc

Author: Hecker165

lib/node_modules/@stdlib/stats/base/stdevyc/benchmark/benchmark.js

@@ -26,10 +26,10 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
 var stdevyc = require( './../lib/main.js' );
- 
- 
+
+
  // VARIABLES //
- 
+
  var options = {
  	'dtype': 'generic'
  };

lib/node_modules/@stdlib/stats/base/stdevyc/benchmark/benchmark.ndarray.js

@@ -28,7 +28,7 @@ var pkg = require( './../package.json' ).name;
 var stdevyc = require( './../lib/ndarray.js' );
 
 // VARIABLES //
- 
+
 var options = {
 	'dtype': 'generic'
 };

lib/node_modules/@stdlib/stats/base/stdevyc/lib/index.js

@@ -45,10 +45,10 @@
 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
  var main = require( './main.js' );
  var ndarray = require( './ndarray.js' );
- 
- 
+
+
  // MAIN //
- 
+
  setReadOnly( main, 'ndarray', ndarray );
 
 // EXPORTS //

lib/node_modules/@stdlib/stats/base/stdevyc/lib/main.js

@@ -46,7 +46,7 @@ var ndarray = require( './ndarray.js' );
  * // returns ~2.0817
  */
 function stdevyc( N, correction, x, strideX ) {
-    return ndarray( N, correction, x, strideX, stride2offset( N, strideX ) );
+	return ndarray( N, correction, x, strideX, stride2offset( N, strideX ) );
 }
 
 // EXPORTS //

lib/node_modules/@stdlib/stats/base/stdevyc/lib/ndarray.js

@@ -50,16 +50,16 @@ var varianceyc = require( '@stdlib/stats/base/varianceyc' ).ndarray;
 * // returns ~2.0817
 */
 function stdevyc( N, correction, x, strideX, offsetX ) {
-    var o;
-    
-    if ( N <= 0 ) {
-        return NaN;
-    }
-    o = arraylike2object( x );
-    if ( o.accessorProtocol ) {
-        return accessors( N, correction, o, strideX, offsetX );
-    }
-    return sqrt( varianceyc( N, correction, x, strideX, offsetX ) );
+	var o;
+	
+	if ( N <= 0 ) {
+		return NaN;
+	}
+	o = arraylike2object( x );
+	if ( o.accessorProtocol ) {
+		return accessors( N, correction, o, strideX, offsetX );
+	}
+	return sqrt( varianceyc( N, correction, x, strideX, offsetX ) );
 }
 
 

lib/node_modules/@stdlib/stats/base/stdevyc/lib/stdevyc.js

@@ -49,16 +49,16 @@ var varianceyc = require( '@stdlib/stats/base/varianceyc' ).ndarray;
 * // returns ~2.0817
 */
 function stdevyc( N, correction, x, strideX, offsetX ) {
-    var o;
-    
-    if ( N <= 0 ) {
-        return NaN;
-    }
-    o = arraylike2object( x );
-    if ( o.accessorProtocol ) {
-        return accessors( N, correction, o, strideX, offsetX );
-    }
-    return sqrt( varianceyc( N, correction, x, strideX, offsetX ) );
+	var o;
+
+	if ( N <= 0 ) {
+		return NaN;
+	}
+	o = arraylike2object( x );
+	if ( o.accessorProtocol ) {
+		return accessors( N, correction, o, strideX, offsetX );
+	}
+	return sqrt( varianceyc( N, correction, x, strideX, offsetX ) );
 }
 
 

lib/node_modules/@stdlib/stats/base/stdevyc/test/test.ndarray.js

@@ -59,30 +59,25 @@ tape( 'the function calculates the population standard deviation of a strided ar
 	t.end();
 });
 
-tape( 'the function calculates the standard deviation of a strided array (accessors)', function test( t ) {
-    var x;
-    var v;
-
-    x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
-    v = stdevyc( x.length, 0, toAccessorArray( x ), 1, 0 );
-    t.strictEqual( v, sqrt( 53.5 / x.length ), 'returns expected value' );
+tape( 'the function calculates the population standard deviation of a strided array (accessor)', function test( t ) {
+	var x;
+	var v;
 
-    x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
-    v = stdevyc( x.length, 1, toAccessorArray( x ), 1, 0 );
-    t.strictEqual( v, sqrt( 53.5 / (x.length - 1) ), 'returns expected value' );
+	x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] );
+	v = stdevyc( x.length, 0, x, 1, 0 );
+	t.strictEqual( v, sqrt( 53.5/x.length ), 'returns expected value' );
 
-    x = [ -4.0, -4.0 ];
-    v = stdevyc( x.length, 0, toAccessorArray( x ), 1, 0 );
-    t.strictEqual( v, 0.0, 'returns expected value' );
+	x = [ -4.0, -4.0 ];
+	v = stdevyc( x.length, 0, x, 1, 0 );
+	t.strictEqual( v, 0.0, 'returns expected value' );
 
-    x = [ NaN, 4.0 ];
-    v = stdevyc( x.length, 0, toAccessorArray( x ), 1, 0 );
-    t.strictEqual( isnan( v ), true, 'returns expected value' );
+	x = [ NaN, 4.0 ];
+	v = stdevyc( x.length, 0, x, 1, 0 );
+	t.strictEqual( isnan( v ), true, 'returns expected value' );
 
-    t.end();
+	t.end();
 });
 
-
 tape( 'the function calculates the sample standard deviation of a strided array', function test( t ) {
 	var x;
 	var v;
@@ -117,6 +112,21 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu
 	t.end();
 });
 
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` (accessor)', function test( t ) {
+	var x;
+	var v;
+
+	x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+	v = stdevyc( 0, 1, toAccessorArray( x ), 1, 0 );
+	t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+	v = stdevyc( -1, 1, toAccessorArray( x ), 1, 0 );
+	t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0`', function test( t ) {
 	var x;
 	var v;
@@ -129,6 +139,18 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns a populat
 	t.end();
 });
 
+tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0` (accessor)', function test( t ) {
+	var x;
+	var v;
+
+	x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+	v = stdevyc( 1, 0, toAccessorArray( x ), 1, 0 );
+	t.strictEqual( v, 0.0, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN`', function test( t ) {
 	var x;
 	var v;
@@ -144,6 +166,21 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or
 	t.end();
 });
 
+tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN` (accessor)', function test( t ) {
+	var x;
+	var v;
+
+	x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ];
+
+	v = stdevyc( x.length, x.length, toAccessorArray( x ), 1, 0 );
+	t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+	v = stdevyc( x.length, x.length+1, toAccessorArray( x ), 1, 0 );
+	t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'the function supports a `stride` parameter', function test( t ) {
 	var x;
 	var v;
@@ -165,7 +202,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
 	t.end();
 });
 
-tape( 'the function supports a `stride` parameter', function test( t ) {
+tape( 'the function supports a `stride` parameter (accessor)', function test( t ) {
 	var x;
 	var v;
 
@@ -207,7 +244,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
 	t.end();
 });
 
-tape( 'the function supports a negative `stride` parameter', function test( t ) {
+tape( 'the function supports a negative `stride` parameter (accessor)', function test( t ) {
 	var x;
 	var v;
 
@@ -228,7 +265,6 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
 	t.end();
 });
 
-
 tape( 'if provided a `stride` parameter equal to `0`, the function returns `0`', function test( t ) {
 	var x;
 	var v;
@@ -241,7 +277,7 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns `0`',
 	t.end();
 });
 
-tape( 'if provided a `stride` parameter equal to `0`, the function returns `0`', function test( t ) {
+tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` (accessor)', function test( t ) {
 	var x;
 	var v;
 
@@ -274,7 +310,7 @@ tape( 'the function supports an `offset` parameter', function test( t ) {
 	t.end();
 });
 
-tape( 'the function supports an `offset` parameter', function test( t ) {
+tape( 'the function supports an `offset` parameter (accessor)', function test( t ) {
 	var x;
 	var v;
 
@@ -293,4 +329,4 @@ tape( 'the function supports an `offset` parameter', function test( t ) {
 	t.strictEqual( v, 2.5, 'returns expected value' );
 
 	t.end();
-});
+});