Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -179,3 +179,8 @@ indent_size = 2
 [*.gypi]
 indent_style = space
 indent_size = 2
+
+# Set properties for citation files:
+[*.{cff,cff.txt}]
+indent_style = space
+indent_size = 2

CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # Assert
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

dist/index.js

@@ -0,0 +1,94 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# isMultiSlice
+
+> Test if a value is a [`MultiSlice`][@stdlib/slice/multi].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isMultiSlice = require( '@stdlib/assert/is-multi-slice' );
+```
+
+#### isMultiSlice( value )
+
+Tests if a value is a [`MultiSlice`][@stdlib/slice/multi].
+
+```javascript
+var MultiSlice = require( '@stdlib/slice/multi' );
+
+var s = new MultiSlice();
+
+var bool = isMultiSlice( s );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Slice = require( '@stdlib/slice/ctor' );
+var MultiSlice = require( '@stdlib/slice/multi' );
+var isMultiSlice = require( '@stdlib/assert/is-multi-slice' );
+
+var out = isMultiSlice( new MultiSlice() );
+// returns true
+
+out = isMultiSlice( new Slice( 0, 10, 1 ) );
+// returns false
+
+out = isMultiSlice( {} );
+// returns false
+
+out = isMultiSlice( null );
+// returns false
+```
+
+</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">
+
+[@stdlib/slice/multi]: https://github.com/stdlib-js/slice-multi
+
+</section>
+
+<!-- /.links -->

dist/index.js.map

@@ -0,0 +1,87 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 isBoolean = require( './../../is-boolean' ).isPrimitive;
+var MultiSlice = require( '@stdlib/slice/multi' );
+var pkg = require( './../package.json' ).name;
+var isMultiSlice = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+'::true', function benchmark( b ) {
+	var values;
+	var bool;
+	var i;
+
+	values = [
+		new MultiSlice( 1, 2 ),
+		new MultiSlice( 3, 4 ),
+		new MultiSlice( 5, 6 ),
+		new MultiSlice( 7, 8 )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		bool = isMultiSlice( values[ i%values.length ] );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::false', function benchmark( b ) {
+	var values;
+	var bool;
+	var i;
+
+	values = [
+		'5',
+		5,
+		NaN,
+		true,
+		false,
+		[],
+		{}
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		bool = isMultiSlice( values[ i%values.length ] );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

is-multi-slice/README.md

@@ -0,0 +1,26 @@
+
+{{alias}}( value )
+    Tests if a value is a MultiSlice object.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether a value is a MultiSlice object.
+
+    Examples
+    --------
+    > var bool = {{alias}}( new {{alias:@stdlib/slice/multi}}() )
+    true
+    > bool = {{alias}}( 3.14 )
+    false
+    > bool = {{alias}}( {} )
+    false
+
+    See Also
+    --------
+

is-multi-slice/benchmark/benchmark.js

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 { MultiSlice } from '@stdlib/types/slice';
+
+/**
+* Tests if a value is a MultiSlice object.
+*
+* @param value - value to test
+* @returns boolean indicating if a value is a MultiSlice object
+*
+* @example
+* var Slice = require( `@stdlib/slice/ctor` );
+* var MultiSlice = require( `@stdlib/slice/multi` );
+*
+* var s = new MultiSlice( new Slice( 0, 10, 1 ), null, 1 );
+*
+* var bool = isMultiSlice( s );
+* // returns true
+*/
+declare function isMultiSlice( value: any ): value is MultiSlice;
+
+
+// EXPORTS //
+
+export = isMultiSlice;

is-multi-slice/docs/repl.txt

@@ -0,0 +1,36 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 MultiSlice = require( '@stdlib/slice/multi' );
+import isMultiSlice = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isMultiSlice( new MultiSlice( null ) ); // $ExpectType boolean
+	isMultiSlice( { 'ndims': 0, 'data': [] } ); // $ExpectType boolean
+	isMultiSlice( 123 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isMultiSlice(); // $ExpectError
+	isMultiSlice( new MultiSlice( null ), 123 ); // $ExpectError
+}