Skip to content
Open
203 changes: 203 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gediff/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# gediff

> Calculate the differences between consecutive elements of a strided array.

<section class="usage">

## Usage

```javascript
var gediff = require( '@stdlib/blas/ext/base/gediff' );
```

<!-- lint disable maximum-heading-length -->

#### gediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )

<!-- lint enable maximum-heading-length -->

Calculates the differences between consecutive elements of a strided array.

```javascript
var x = [ 2.0, 4.0, 6.0, 8.0, 10.0 ];
var p = [ 1.0 ];
var a = [ 11.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gediff( x.length, x, 1, 1, p, 1, 1, a, 1, out, 1 );
// out => [ 1.0, 2.0, 2.0, 2.0, 2.0, 11.0 ]
```

The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input array.
- **strideX**: stride length for `x`.
- **N1**: number of indexed elements to prepend.
- **prepend**: array containing values to prepend after computing differences.
- **strideP**: stride length for `prepend`.
- **N2**: number of indexed elements to append.
- **append**: array containing values to append after computing differences.
- **strideA**: stride length for `append`.
- **out**: output array. Must have `N + N1 + N2 - 1` indexed elements.
- **strideOut**: stride length for `out`.

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute differences of every other element:

```javascript
var x = [ 2.0, 4.0, 6.0, 8.0, 10.0 ];
var p = [ 1.0 ];
var a = [ 11.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0 ];

gediff( 3, x, 2, 1, p, 1, 1, a, 1, out, 1 );
// out => [ 1.0, 4.0, 4.0, 11.0 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

// Initial array...
var x0 = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] );

// Create an offset view...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var p = [ 1.0 ];
var a = [ 11.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];

gediff( x1.length, x1, 1, 1, p, 1, 1, a, 1, out, 1 );
// out => [ 1.0, 2.0, 2.0, 2.0, 11.0 ]
```

<!-- lint disable maximum-heading-length -->

#### gediff.ndarray( N, x, strideX, offsetX, N1, prepend, strideP, offsetP, N2, append, strideA, offsetA, out, strideOut, offsetOut )

<!-- lint enable maximum-heading-length -->

Calculates the differences between consecutive elements of a strided array using alternative indexing semantics.

```javascript
var x = [ 2.0, 4.0, 6.0, 8.0, 10.0 ];
var p = [ 1.0 ];
var a = [ 11.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

gediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
// out => [ 1.0, 2.0, 2.0, 2.0, 2.0, 11.0 ]
```

The function has the following additional parameters:

- **offsetX**: starting index for `x`.
- **offsetP**: starting index for `prepend`.
- **offsetA**: starting index for `append`.
- **offsetOut**: starting index for `out`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements:

```javascript
var x = [ 2.0, 4.0, 6.0, 8.0, 10.0 ];
var p = [ 1.0 ];
var a = [ 11.0 ];
var out = [ 0.0, 0.0, 0.0, 0.0 ];

gediff.ndarray( 3, x, 1, x.length-3, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
// out => [ 1.0, 2.0, 2.0, 11.0 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N + N1 + N2 <= 1`, both functions return the output array unchanged.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var zeros = require( '@stdlib/array/zeros' );
var gediff = require( '@stdlib/blas/ext/base/gediff' );

var x = discreteUniform( 10, -100, 100, {
'dtype': 'generic'
});
console.log( 'Input array:', x );

var p = discreteUniform( 2, -100, 100, {
'dtype': 'generic'
});
console.log( 'Prepend array:', p );

var a = discreteUniform( 2, -100, 100, {
'dtype': 'generic'
});
console.log( 'Append array:', a );

var out = zeros( 13, 'generic' );

gediff( x.length, x, 1, p.length, p, 1, a.length, a, 1, out, 1 );
console.log( 'Output:', out );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
121 changes: 121 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gediff/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var zeros = require( '@stdlib/array/zeros' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gediff = require( './../lib/main.js' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var ol;
var N1;
var N2;
var x;
var p;
var a;
var o;
var N;

N = len;
N1 = 1;
N2 = 1;
ol = N + N1 + N2 - 1;

x = uniform( N, -100, 100, options );
p = uniform( N1, -100, 100, options );
a = uniform( N2, -100, 100, options );
o = zeros( ol, 'generic' );

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
gediff( N, x, 1, N1, p, 1, N2, a, 1, o, 1 );
if ( isnan( o[ i%ol ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( o[ i%ol ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Loading