Skip to content

Commit

Permalink
refactor: use stdlib package to sum five numbers
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed Nov 21, 2023
1 parent 19b9334 commit d1b801d
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 141 deletions.
30 changes: 6 additions & 24 deletions lib/node_modules/@stdlib/strided/base/quinary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,9 @@ var quinary = require( '@stdlib/strided/base/quinary' );
Applies a quinary callback to strided input array elements and assigns results to elements in a strided output array.

```javascript
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand All @@ -68,12 +65,9 @@ The function accepts the following arguments:
The `shape` and `strides` parameters determine which elements in the strided input and output arrays are accessed at runtime. For example, to index every other value in the strided input arrays and to index the first `N` elements of the strided output array in reverse order,

```javascript
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand All @@ -88,12 +82,9 @@ quinary( [ x, y, z, w, u, v ], [ 3 ], [ 2, 2, 2, 2, 2, -1 ], add );
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

```javascript
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

// Initial arrays...
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
Expand Down Expand Up @@ -121,12 +112,9 @@ Applies a quinary callback to strided input array elements and assigns results t
<!-- eslint-disable max-len -->

```javascript
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand All @@ -147,12 +135,9 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
<!-- eslint-disable max-len -->

```javascript
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
Expand Down Expand Up @@ -184,12 +169,9 @@ quinary.ndarray( [ x, y, z, w, u, v ], [ 3 ], [ 2, 2, 2, 2, 2, -1 ], [ 1, 1, 1,
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarray = require( '@stdlib/array/filled' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var add = require( '@stdlib/math/base/ops/add5' );
var quinary = require( '@stdlib/strided/base/quinary' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var N = 10;

var x = filledarrayBy( N, 'generic', discreteUniform( -100, 100 ) );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var round = require( '@stdlib/math/base/special/round' );
var filledarray = require( '@stdlib/array/filled' );
var add = require( '@stdlib/math/base/ops/add5' );
var pkg = require( './../package.json' ).name;
var quinary = require( './../lib/main.js' );

Expand All @@ -37,21 +38,6 @@ var types = [ 'float64' ];

// FUNCTIONS //

/**
* Returns the sum.
*
* @private
* @param {number} x - value
* @param {number} y - value
* @param {number} z - value
* @param {number} w - value
* @param {number} u - value
* @returns {number} sum
*/
function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

/**
* Creates a benchmark function.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var round = require( '@stdlib/math/base/special/round' );
var filledarray = require( '@stdlib/array/filled' );
var add = require( '@stdlib/math/base/ops/add5' );
var pkg = require( './../package.json' ).name;
var quinary = require( './../lib/ndarray.js' );

Expand All @@ -37,21 +38,6 @@ var types = [ 'float64' ];

// FUNCTIONS //

/**
* Returns the sum.
*
* @private
* @param {number} x - value
* @param {number} y - value
* @param {number} z - value
* @param {number} w - value
* @param {number} u - value
* @returns {number} sum
*/
function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

/**
* Creates a benchmark function.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,9 @@ interface Routine {
* @param fcn - quinary callback
*
* @example
* var add = require( `@stdlib/math/base/ops/add5` );
* var Float64Array = require( `@stdlib/array/float64` );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down Expand Up @@ -80,12 +77,9 @@ interface Routine {
* @param fcn - quinary callback
*
* @example
* var add = require( `@stdlib/math/base/ops/add5` );
* var Float64Array = require( `@stdlib/array/float64` );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down Expand Up @@ -114,12 +108,9 @@ interface Routine {
* @param fcn - quinary callback
*
* @example
* var add = require( `@stdlib/math/base/ops/add5` );
* var Float64Array = require( `@stdlib/array/float64` );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand All @@ -136,12 +127,9 @@ interface Routine {
* // => <Float64Array>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
*
* @example
* var add = require( `@stdlib/math/base/ops/add5` );
* var Float64Array = require( `@stdlib/array/float64` );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,9 @@
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarray = require( '@stdlib/array/filled' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var add = require( '@stdlib/math/base/ops/add5' );
var quinary = require( './../lib' );

function add( x, y, z, w, u ) {
return x + y + z + w + u;
}

var N = 10;

var x = filledarrayBy( N, 'generic', discreteUniform( -100, 100 ) );
Expand Down
10 changes: 2 additions & 8 deletions lib/node_modules/@stdlib/strided/base/quinary/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,10 @@
* @module @stdlib/strided/base/quinary
*
* @example
* var add = require( '@stdlib/math/base/ops/add5' );
* var Float64Array = require( '@stdlib/array/float64' );
* var quinary = require( '@stdlib/strided/base/quinary' );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand All @@ -47,13 +44,10 @@
* // => <Float64Array>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
*
* @example
* var add = require( '@stdlib/math/base/ops/add5' );
* var Float64Array = require( '@stdlib/array/float64' );
* var quinary = require( '@stdlib/strided/base/quinary' );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/strided/base/quinary/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,9 @@
* @returns {void}
*
* @example
* var add = require( '@stdlib/math/base/ops/add5' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/strided/base/quinary/lib/ndarray.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,9 @@
* @returns {void}
*
* @example
* var add = require( '@stdlib/math/base/ops/add5' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* function add( x, y, z, w, u ) {
* return x + y + z + w + u;
* }
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
Expand Down
41 changes: 0 additions & 41 deletions lib/node_modules/@stdlib/strided/base/quinary/test/fixtures/add.js

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,11 @@

var tape = require( 'tape' );
var floor = require( '@stdlib/math/base/special/floor' );
var add = require( '@stdlib/math/base/ops/add5' );
var Float64Array = require( '@stdlib/array/float64' );
var quinary = require( './../lib/main.js' );


// FIXTURES //

var add = require( './fixtures/add.js' );


// TESTS //

tape( 'main export is a function', function test( t ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,10 @@

var tape = require( 'tape' );
var Float64Array = require( '@stdlib/array/float64' );
var add = require( '@stdlib/math/base/ops/add5' );
var quinary = require( './../lib/ndarray.js' );


// FIXTURES //

var add = require( './fixtures/add.js' );


// TESTS //

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

1 comment on commit d1b801d

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base/broadcasted-quaternary2d $\color{green}217/217$
$\color{green}+100.00\%$
$\color{green}8/8$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}217/217$
$\color{green}+100.00\%$
array/base/quaternary2d $\color{green}147/147$
$\color{green}+100.00\%$
$\color{green}8/8$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}147/147$
$\color{green}+100.00\%$
strided/base/quaternary $\color{green}304/304$
$\color{green}+100.00\%$
$\color{green}26/26$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}304/304$
$\color{green}+100.00\%$
strided/base/quinary $\color{green}326/326$
$\color{green}+100.00\%$
$\color{green}29/29$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}326/326$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.