Skip to content

Commit 78eb555

Browse files
aayush0325ShabiShett07
authored andcommitted
docs: minor changes in docs of stats/base/max
PR-URL: stdlib-js#5043 Reviewed-by: Athan Reines <[email protected]>
1 parent 0340f1e commit 78eb555

File tree

4 files changed

+6
-9
lines changed

4 files changed

+6
-9
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var options = {
4545
* @returns {Function} benchmark function
4646
*/
4747
function createBenchmark( len ) {
48-
var x = uniform( len, -100, 100, options );
48+
var x = uniform( len, -10, 10, options );
4949
return benchmark;
5050

5151
function benchmark( b ) {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var options = {
4545
* @returns {Function} benchmark function
4646
*/
4747
function createBenchmark( len ) {
48-
var x = uniform( len, -100, 100, options );
48+
var x = uniform( len, -10, 10, options );
4949
return benchmark;
5050

5151
function benchmark( b ) {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
3636
* @param {Array<Function>} x.accessors - array element accessors
3737
* @param {integer} strideX - stride length
3838
* @param {NonNegativeInteger} offsetX - starting index
39-
* @returns {number} sum
39+
* @returns {number} maximum value
4040
*
4141
* @example
4242
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );

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

+3-6
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,16 @@
2727
* var max = require( '@stdlib/stats/base/max' );
2828
*
2929
* var x = [ 1.0, -2.0, 2.0 ];
30-
* var N = x.length;
3130
*
32-
* var v = max( N, x, 1 );
31+
* var v = max( x.length, x, 1 );
3332
* // returns 2.0
3433
*
3534
* @example
36-
* var floor = require( '@stdlib/math/base/special/floor' );
3735
* var max = require( '@stdlib/stats/base/max' );
3836
*
3937
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
40-
* var N = floor( x.length / 2 );
4138
*
42-
* var v = max.ndarray( N, x, 2, 1 );
39+
* var v = max.ndarray( 4, x, 2, 1 );
4340
* // returns 4.0
4441
*/
4542

@@ -59,4 +56,4 @@ setReadOnly( main, 'ndarray', ndarray );
5956

6057
module.exports = main;
6158

62-
// exports: { "ndarray": "max.ndarray" }
59+
// exports: { "ndarray": "main.ndarray" }

0 commit comments

Comments
 (0)