Auto-generated commit

stdlib-js · Feb 6, 2024 · 8d2c5b3 · 8d2c5b3
1 parent 5f72017
commit 8d2c5b3
Show file tree

Hide file tree

Showing 13 changed files with 771 additions and 24 deletions.
diff --git a/base/int2slice/README.md b/base/int2slice/README.md
@@ -0,0 +1,143 @@
+<!--
+
+@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.
+
+-->
+
+# int2slice
+
+> Convert an integer to a [`Slice`][@stdlib/slice/ctor] object.
+
+<!-- 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 int2slice = require( '@stdlib/slice/base/int2slice' );
+```
+
+<a name="main"></a>
+
+#### int2slice( value, max, strict )
+
+Converts an integer to a [`Slice`][@stdlib/slice/ctor] object, where `max` specifies the index upper bound.
+
+<!-- eslint-disable stdlib/no-redeclare -->
+
+```javascript
+var s = int2slice( -4, 10, false );
+// returns <Slice>
+
+var start = s.start;
+// returns 6
+
+var stop = s.stop;
+// returns 7
+
+var step = s.step;
+// returns 1
+```
+
+When `strict` is `true`, the function returns an error object if an input value exceeds index bounds.
+
+```javascript
+var s = int2slice( 100, 10, true );
+// returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' }
+```
+
+A returned error object may have one of the following error codes:
+
+-   **ERR_SLICE_OUT_OF_BOUNDS**: a slice exceeds index bounds.
+
+</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">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var int2slice = require( '@stdlib/slice/base/int2slice' );
+
+var s = int2slice( -1, 7, false );
+console.log( '%s', s.toString() );
+
+s = int2slice( 3, 5, false );
+console.log( '%s', s.toString() );
+
+s = int2slice( -3, 5, false );
+console.log( '%s', s.toString() );
+
+s = int2slice( 10, 5, false );
+console.log( '%s', s.toString() );
+
+s = int2slice( -10, 5, false );
+console.log( '%s', s.toString() );
+```
+
+</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">
+
+[@stdlib/slice/ctor]: https://github.com/stdlib-js/slice/tree/main/ctor
+
+</section>
+
+<!-- /.links -->
diff --git a/base/int2slice/benchmark/benchmark.js b/base/int2slice/benchmark/benchmark.js
@@ -0,0 +1,59 @@
+/**
+* @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 isSlice = require( '@stdlib/assert/is-slice' );
+var pkg = require( './../package.json' ).name;
+var int2slice = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		-3,
+		4,
+		5,
+		-1,
+		-2,
+		100,
+		-100
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = int2slice( values[ i%values.length ], 10, false );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isSlice( out ) ) {
+		b.fail( 'should return a slice object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
diff --git a/base/int2slice/docs/repl.txt b/base/int2slice/docs/repl.txt
@@ -0,0 +1,44 @@
+
+{{alias}}( value, max, strict )
+    Converts an integer to a Slice object.
+
+    In strict mode, the function returns an error object if an input value
+    exceeds index bounds.
+
+    A returned error object is a plain object having the following properties:
+
+    - code: error code.
+
+    A returned error object may have one of the following error codes:
+
+    - ERR_SLICE_OUT_OF_BOUNDS: a slice exceeds index bounds.
+
+    Parameters
+    ----------
+    value: integer
+        Input value.
+
+    max: integer
+        Index upper bound (exclusive).
+
+    strict: boolean
+        Boolean indicating whether to enforce strict bounds checking.
+
+    Returns
+    -------
+    s: Slice|Object
+        Slice instance (or an error object).
+
+    Examples
+    --------
+    > var s = {{alias}}( -1, 5, false );
+    > s.start
+    4
+    > s.stop
+    5
+    > s.step
+    1
+
+    See Also
+    --------
+
diff --git a/base/int2slice/docs/types/index.d.ts b/base/int2slice/docs/types/index.d.ts
@@ -0,0 +1,70 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { Slice } from '@stdlib/types/slice';
+
+/**
+* Interface describing an error object.
+*/
+interface ErrorObject {
+	/**
+	* Error code.
+	*/
+	code: 'ERR_SLICE_OUT_OF_BOUNDS';
+}
+
+/**
+* Slice return value.
+*/
+type SliceResult = Slice | ErrorObject;
+
+/**
+* Converts an integer to a Slice object.
+*
+* ## Notes
+*
+* -   If `strict` is `true`, the function returns an error object when an input value exceeds index bounds.
+*
+* @param value - input value
+* @param max - index upper bound (exclusive)
+* @param strict - boolean indicating whether to enforce strict bounds checking
+* @returns Slice object (or an error object)
+*
+* @example
+* var s = int2slice( -4, 10, false );
+* // returns <Slice>
+*
+* var start = s.start;
+* // returns 6
+*
+* var stop = s.stop;
+* // returns 7
+*
+* var step = s.step;
+* // returns 1
+*/
+declare function int2slice( value: number, max: number, strict: boolean ): SliceResult;
+
+
+// EXPORTS //
+
+export = int2slice;
diff --git a/base/int2slice/docs/types/test.ts b/base/int2slice/docs/types/test.ts
@@ -0,0 +1,71 @@
+/*
+* @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 int2slice = require( './index' );
+
+
+// TESTS //
+
+// The function returns a Slice object or an error object...
+{
+	int2slice( 0, 10, false ); // $ExpectType SliceResult
+	int2slice( 0, 10, true ); // $ExpectType SliceResult
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a number...
+{
+	int2slice( '1', 10, false ); // $ExpectError
+	int2slice( true, 10, false ); // $ExpectError
+	int2slice( false, 10, false ); // $ExpectError
+	int2slice( null, 10, false ); // $ExpectError
+	int2slice( undefined, 10, false ); // $ExpectError
+	int2slice( [], 10, false ); // $ExpectError
+	int2slice( {}, 10, false ); // $ExpectError
+	int2slice( ( x: number ): number => x, 10, false ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a number...
+{
+	int2slice( 0, '1', false ); // $ExpectError
+	int2slice( 0, true, false ); // $ExpectError
+	int2slice( 0, false, false ); // $ExpectError
+	int2slice( 0, null, false ); // $ExpectError
+	int2slice( 0, undefined, false ); // $ExpectError
+	int2slice( 0, [], false ); // $ExpectError
+	int2slice( 0, {}, false ); // $ExpectError
+	int2slice( 0, ( x: number ): number => x, false ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a third argument which is not a boolean...
+{
+	int2slice( 0, 10, '1' ); // $ExpectError
+	int2slice( 0, 10, 1 ); // $ExpectError
+	int2slice( 0, 10, null ); // $ExpectError
+	int2slice( 0, 10, undefined ); // $ExpectError
+	int2slice( 0, 10, [] ); // $ExpectError
+	int2slice( 0, 10, {} ); // $ExpectError
+	int2slice( 0, 10, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	int2slice(); // $ExpectError
+	int2slice( 0 ); // $ExpectError
+	int2slice( 0, 10 ); // $ExpectError
+	int2slice( 0, 10, false, {} ); // $ExpectError
+}