feat: add array/base/remove-at

Author: kgryte

lib/node_modules/@stdlib/array/base/remove-at/README.md

@@ -0,0 +1,131 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# removeAt
+
+> Remove an element from an array.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var removeAt = require( '@stdlib/array/base/remove-at' );
+```
+
+#### removeAt( x, index )
+
+Removes an element from an array.
+
+```javascript
+var x = [ 1, 1, 2, 3, 3 ];
+
+var y = removeAt( x, -3 );
+// returns [ 1, 1, 3, 3 ]
+
+var bool = ( x === y );
+// returns true
+```
+
+The function accepts the following arguments:
+
+-   **x**: an input array.
+-   **index**: element index.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   Negative indices are resolved relative to the last array element, with the last element corresponding to `-1`.
+-   If provided out-of-bounds indices, the function returns the input array unchanged; otherwise, the function mutates the input array.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var randi = require( '@stdlib/random/base/discrete-uniform' );
+var removeAt = require( '@stdlib/array/base/remove-at' );
+
+// Create an array of random numbers:
+var x = discreteUniform( 30, 0, 5, {
+    'dtype': 'generic'
+});
+// returns [...]
+
+// Remove a random element:
+var y = removeAt( x, randi( 0, x.length-1 ) );
+// returns [...]
+
+console.log( y );
+```
+
+</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/array/base/remove-at/benchmark/benchmark.length.js

@@ -0,0 +1,98 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 pow = require( '@stdlib/math/base/special/pow' );
+var isArray = require( '@stdlib/assert/is-array' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var removeAt = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var x;
+		var i;
+
+		x = zeroTo( b.iterations+1 );
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = removeAt( x, -1 );
+			if ( out.length === len ) {
+				b.fail( 'unexpected length' );
+			}
+		}
+		b.toc();
+		if ( !isArray( out ) ) {
+			b.fail( 'should return an array' );
+		}
+		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( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/remove-at/docs/repl.txt

@@ -0,0 +1,34 @@
+
+{{alias}}( x, index )
+    Removes an element from an array.
+
+    Negative indices are resolved relative to the last array element, with the
+    last element corresponding to `-1`.
+
+    If provided an out-of-bounds index, the function returns the input array
+    unchanged; otherwise, the function mutates the input array.
+
+    Parameters
+    ----------
+    x: Array
+        Input array.
+
+    index: integer
+        Element index.
+
+    Returns
+    -------
+    out: Array
+        Input array.
+
+    Examples
+    --------
+    > var x = [ 1, 1, 2, 3, 3 ];
+    > var out = {{alias}}( x, -3 )
+    [ 1, 1, 3, 3 ]
+    > var bool = ( out === x )
+    true
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/array/base/remove-at/docs/types/index.d.ts

@@ -0,0 +1,46 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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
+
+/**
+* Removes an element from an array.
+*
+* ## Notes
+*
+* -   The function mutates the input array.
+*
+* @param x - input array
+* @param index - element index
+* @returns input array
+*
+* @example
+* var x = [ 1, 1, 2, 3, 3 ];
+*
+* var y = removeAt( x, -2 );
+* // returns [ 1, 1, 3, 3 ]
+*
+* var bool = ( x === y );
+* // returns true
+*/
+declare function removeAt<T = unknown>( x: Array<T>, index: number ): Array<T>;
+
+
+// EXPORTS //
+
+export = removeAt;

lib/node_modules/@stdlib/array/base/remove-at/docs/types/test.ts

@@ -0,0 +1,62 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+import removeAt = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array...
+{
+	removeAt( [ 1, 2, 3 ], -1 ); // $ExpectType number[]
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array...
+{
+	removeAt( '5', -1 ); // $ExpectError
+	removeAt( 5, -1 ); // $ExpectError
+	removeAt( true, -1 ); // $ExpectError
+	removeAt( false, -1 ); // $ExpectError
+	removeAt( null, -1 ); // $ExpectError
+	removeAt( void 0, -1 ); // $ExpectError
+	removeAt( {}, -1 ); // $ExpectError
+	removeAt( ( x: number ): number => x, -1 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a number...
+{
+	const x = [ 1, 2, 3 ];
+
+	removeAt( x, '5' ); // $ExpectError
+	removeAt( x, true ); // $ExpectError
+	removeAt( x, false ); // $ExpectError
+	removeAt( x, null ); // $ExpectError
+	removeAt( x, void 0 ); // $ExpectError
+	removeAt( x, {} ); // $ExpectError
+	removeAt( x, [] ); // $ExpectError
+	removeAt( x, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = [ 1, 2, 3 ];
+
+	removeAt(); // $ExpectError
+	removeAt( x ); // $ExpectError
+	removeAt( x, -1, {} ); // $ExpectError
+}