Skip to content

Commit b21e681

Browse files
committed
docs: refactor examples to use base math package
1 parent 4822c66 commit b21e681

File tree

7 files changed

+8
-57
lines changed

7 files changed

+8
-57
lines changed

lib/node_modules/@stdlib/array/base/quinary2d/README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,9 @@ var quinary2d = require( '@stdlib/array/base/quinary2d' );
4141
Applies a quinary callback to elements in five two-dimensional nested input arrays and assigns results to elements in a two-dimensional nested output array.
4242

4343
```javascript
44+
var add = require( '@stdlib/math/base/ops/add5' );
4445
var zeros2d = require( '@stdlib/array/base/zeros2d' );
4546

46-
function add( x, y, z, w, v ) {
47-
return x + y + z + w + v;
48-
}
49-
5047
var x = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ];
5148
var out = zeros2d( [ 2, 2 ] );
5249

@@ -86,12 +83,9 @@ The function accepts the following arguments:
8683
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
8784
var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
8885
var zeros2d = require( '@stdlib/array/base/zeros2d' );
86+
var add = require( '@stdlib/math/base/ops/add5' );
8987
var quinary2d = require( '@stdlib/array/base/quinary2d' );
9088

91-
function add( x, y, z, w, v ) {
92-
return x + y + z + w + v;
93-
}
94-
9589
var shape = [ 3, 3 ];
9690

9791
var x = filled2dBy( shape, discreteUniform( -100, 100 ) );

lib/node_modules/@stdlib/array/base/quinary2d/benchmark/benchmark.js

+1-15
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,13 @@ var floor = require( '@stdlib/math/base/special/floor' );
2828
var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
2929
var zeros2d = require( '@stdlib/array/base/zeros2d' );
3030
var numel = require( '@stdlib/ndarray/base/numel' );
31+
var add = require( '@stdlib/math/base/ops/add5' );
3132
var pkg = require( './../package.json' ).name;
3233
var quinary2d = require( './../lib' );
3334

3435

3536
// FUNCTIONS //
3637

37-
/**
38-
* Returns the sum.
39-
*
40-
* @private
41-
* @param {number} x - first value
42-
* @param {number} y - second value
43-
* @param {number} z - third value
44-
* @param {number} w - fourth value
45-
* @param {number} v - fifth value
46-
* @returns {number} sum
47-
*/
48-
function add( x, y, z, w, v ) {
49-
return x + y + z + w + v;
50-
}
51-
5238
/**
5339
* Creates a benchmark function.
5440
*

lib/node_modules/@stdlib/array/base/quinary2d/docs/types/index.d.ts

+1-4
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,10 @@ type Quinary<T, U, V, W, X, Y> = ( v1: T, v2: U, v3: V, v4: W, v5: X ) => Y;
4747
* @param fcn - quinary callback
4848
*
4949
* @example
50+
* var add = require( `@stdlib/math/base/ops/add5` );
5051
* var ones2d = require( `@stdlib/array/base/ones2d` );
5152
* var zeros2d = require( `@stdlib/array/base/zeros2d` );
5253
*
53-
* function add( x, y, z, w, v ) {
54-
* return x + y + z + w + v;
55-
* }
56-
*
5754
* var shape = [ 2, 2 ];
5855
*
5956
* var x = ones2d( shape );

lib/node_modules/@stdlib/array/base/quinary2d/examples/index.js

+1-4
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,9 @@
2121
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
2222
var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
2323
var zeros2d = require( '@stdlib/array/base/zeros2d' );
24+
var add = require( '@stdlib/math/base/ops/add5' );
2425
var quinary2d = require( './../lib' );
2526

26-
function add( x, y, z, w, v ) {
27-
return x + y + z + w + v;
28-
}
29-
3027
var shape = [ 3, 3 ];
3128

3229
var x = filled2dBy( shape, discreteUniform( -100, 100 ) );

lib/node_modules/@stdlib/array/base/quinary2d/lib/index.js

+1-4
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,9 @@
2626
* @example
2727
* var ones2d = require( '@stdlib/array/base/ones2d' );
2828
* var zeros2d = require( '@stdlib/array/base/zeros2d' );
29+
* var add = require( '@stdlib/math/base/ops/add5' );
2930
* var quinary2d = require( '@stdlib/array/base/quinary2d' );
3031
*
31-
* function add( x, y, z, w, v ) {
32-
* return x + y + z + w + v;
33-
* }
34-
*
3532
* var shape = [ 2, 2 ];
3633
*
3734
* var x = ones2d( shape );

lib/node_modules/@stdlib/array/base/quinary2d/lib/main.js

+1-4
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,7 @@
3535
* @example
3636
* var ones2d = require( '@stdlib/array/base/ones2d' );
3737
* var zeros2d = require( '@stdlib/array/base/zeros2d' );
38-
*
39-
* function add( x, y, z, w, v ) {
40-
* return x + y + z + w + v;
41-
* }
38+
* var add = require( '@stdlib/math/base/ops/add5' );
4239
*
4340
* var shape = [ 2, 2 ];
4441
*

lib/node_modules/@stdlib/array/base/quinary2d/test/test.js

+1-18
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,10 @@
2222

2323
var tape = require( 'tape' );
2424
var zeros2d = require( '@stdlib/array/base/zeros2d' );
25+
var add = require( '@stdlib/math/base/ops/add5' );
2526
var quinary2d = require( './../lib' );
2627

2728

28-
// FUNCTIONS //
29-
30-
/**
31-
* Returns the sum.
32-
*
33-
* @private
34-
* @param {number} x - first value
35-
* @param {number} y - second value
36-
* @param {number} z - third value
37-
* @param {number} w - fourth value
38-
* @param {number} v - fifth value
39-
* @returns {number} sum
40-
*/
41-
function add( x, y, z, w, v ) {
42-
return x + y + z + w + v;
43-
}
44-
45-
4629
// TESTS //
4730

4831
tape( 'main export is a function', function test( t ) {

0 commit comments

Comments
 (0)