Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ var gcusumkbn = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn' );
Computes the cumulative sum of a one-dimensional ndarray using an improved Kahan–Babuška algorithm.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );

Expand All @@ -54,13 +53,10 @@ var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );

var v = gcusumkbn( [ x, y, initial ] );
// returns <ndarray>
// returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]

var bool = ( v === y );
// returns true

var arr = ndarray2array( v );
// returns [ 1.0, 4.0, 8.0, 10.0 ]
```

The function has the following parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
> var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
> var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } );
> {{alias}}( [ x, y, s ] );
> {{alias:@stdlib/ndarray/to-array}}( y )
[ 1.0, -1.0, 1.0 ]
> {{alias}}( [ x, y, s ] )
<ndarray>[ 1.0, -1.0, 1.0 ]

See Also
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import { typedndarray } from '@stdlib/types/ndarray';
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
Expand All @@ -42,13 +41,10 @@ import { typedndarray } from '@stdlib/types/ndarray';
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
*
* var v = gcusumkbn( [ x, y, initial ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
*/
declare function gcusumkbn<T extends typedndarray<number> = typedndarray<number>>( arrays: [ T, T, T ] ): T;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
* @module @stdlib/blas/ext/base/ndarray/gcusumkbn
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var gcusumkbn = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn' );
Expand All @@ -38,13 +37,10 @@
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
*
* var v = gcusumkbn( [ x, y, initial ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
*/

// MODULES //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ var strided = require( '@stdlib/blas/ext/base/gcusumkbn' ).ndarray;
* @returns {Object} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
*
Expand All @@ -50,13 +49,10 @@ var strided = require( '@stdlib/blas/ext/base/gcusumkbn' ).ndarray;
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
*
* var v = gcusumkbn( [ x, y, initial ] );
* // returns <ndarray>
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
*
* var bool = ( v === y );
* // returns true
*
* var arr = ndarray2array( v );
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
*/
function gcusumkbn( arrays ) {
var x = arrays[ 0 ];
Expand Down