feat: add blas/ext/base/ndarray/gediff

lib/node_modules/@stdlib/blas/ext/base/ndarray/gediff/README.md

@@ -0,0 +1,132 @@
+<!--
+
+@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 one-dimensional ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var gediff = require( '@stdlib/blas/ext/base/ndarray/gediff' );
+```
+
+#### gediff( arrays )
+
+Calculates the differences between consecutive elements of a one-dimensional ndarray.
+
+```javascript
+var vector = require( '@stdlib/ndarray/vector/ctor' );
+
+var x = vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ], 'generic' );
+var prepend = vector( [ 1.0 ], 'generic' );
+var append = vector( [ 11.0 ], 'generic' );
+var out = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
+
+var y = gediff( [ x, prepend, append, out ] );
+// returns <ndarray>[ 1.0, 2.0, 2.0, 2.0, 2.0, 11.0 ]
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing the following ndarrays:
+
+    -   a one-dimensional input ndarray.
+    -   a one-dimensional ndarray containing values to prepend prior to computing differences.
+    -   a one-dimensional ndarray containing values to append prior to computing differences.
+    -   a one-dimensional output ndarray. Must have `N + N1 + N2 - 1` elements, where `N` is the number of elements in the input ndarray, `N1` is the number of elements to prepend, and `N2` is the number of elements to append.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var gediff = require( '@stdlib/blas/ext/base/ndarray/gediff' );
+
+var N = 10;
+var N1 = 2;
+var N2 = 2;
+var opts = {
+    'dtype': 'generic'
+};
+
+var x = discreteUniform( [ N ], -100, 100, opts );
+var p = discreteUniform( [ N1 ], -100, 100, opts );
+var a = discreteUniform( [ N2 ], -100, 100, opts );
+var out = zeros( [ N + N1 + N2 - 1 ], opts );
+
+console.log( 'x: ', ndarray2array( x ) );
+console.log( 'prepend: ', ndarray2array( p ) );
+console.log( 'append: ', ndarray2array( a ) );
+
+gediff( [ x, p, a, out ] );
+console.log( 'out: ', ndarray2array( out ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- 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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/gediff/benchmark/benchmark.js

@@ -0,0 +1,111 @@
+/**
+* @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/uniform' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var gediff = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var prepend;
+	var append;
+	var out;
+	var x;
+
+	x = uniform( [ len ], -100.0, 100.0, options );
+	prepend = uniform( [ 1 ], -100.0, 100.0, options );
+	append = uniform( [ 1 ], -100.0, 100.0, options );
+	out = zeros( [ len + 1 ], options );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = gediff( [ x, prepend, append, out ] );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+		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();

lib/node_modules/@stdlib/blas/ext/base/ndarray/gediff/docs/repl.txt

@@ -0,0 +1,35 @@
+
+{{alias}}( arrays )
+    Calculates the differences between consecutive elements of a one-dimensional
+    ndarray.
+
+    The output ndarray must have `N + N1 + N2 - 1` elements, where `N` is the
+    number of elements in the input ndarray, `N1` is the number of elements to
+    prepend, and `N2` is the number of elements to append.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing the following ndarrays:
+
+        - a one-dimensional input ndarray.
+        - a one-dimensional ndarray containing values to prepend.
+        - a one-dimensional ndarray containing values to append.
+        - a one-dimensional output ndarray.
+
+    Returns
+    -------
+    out: ndarray
+        Output ndarray.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ 2.0, 4.0, 6.0, 8.0, 10.0 ], 'generic' );
+    > var p = {{alias:@stdlib/ndarray/vector/ctor}}( [ 1.0 ], 'generic' );
+    > var a = {{alias:@stdlib/ndarray/vector/ctor}}( [ 11.0 ], 'generic' );
+    > var out = {{alias:@stdlib/ndarray/vector/ctor}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
+    > {{alias}}( [ x, p, a, out ] )
+    <ndarray>[ 1.0, 2.0, 2.0, 2.0, 2.0, 11.0 ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/blas/ext/base/ndarray/gediff/docs/types/index.d.ts

@@ -0,0 +1,56 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { typedndarray } from '@stdlib/types/ndarray';
+
+/**
+* Calculates the differences between consecutive elements of a one-dimensional ndarray.
+*
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   a one-dimensional input ndarray.
+*     -   a one-dimensional ndarray containing values to prepend.
+*     -   a one-dimensional ndarray containing values to append.
+*     -   a one-dimensional output ndarray.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns output ndarray
+*
+* @example
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
+*
+* var x = vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ], 'generic' );
+* var prepend = vector( [ 1.0 ], 'generic' );
+* var append = vector( [ 11.0 ], 'generic' );
+* var out = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
+*
+* var y = gediff( [ x, prepend, append, out ] );
+* // returns <ndarray>[ 1.0, 2.0, 2.0, 2.0, 2.0, 11.0 ]
+*/
+declare function gediff<T extends typedndarray<number> = typedndarray<number>>( arrays: [ typedndarray<number>, typedndarray<number>, typedndarray<number>, T ] ): T;
+
+
+// EXPORTS //
+
+export = gediff;