Auto-generated commit

base/docs/types/index.d.ts

@@ -21,9 +21,13 @@
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-file-line-count */
 
+import args2multislice = require( './../../../base/args2multislice' );
 import sliceLength = require( './../../../base/length' );
+import nonreducedDimensions = require( './../../../base/nonreduced-dimensions' );
 import normalizeMultiSlice = require( './../../../base/normalize-multi-slice' );
 import normalizeSlice = require( './../../../base/normalize-slice' );
+import reducedDimensions = require( './../../../base/reduced-dimensions' );
+import sargs2multislice = require( './../../../base/sargs2multislice' );
 import seq2multislice = require( './../../../base/seq2multislice' );
 import seq2slice = require( './../../../base/seq2slice' );
 import sliceShape = require( './../../../base/shape' );
@@ -35,6 +39,50 @@ import str2slice = require( './../../../base/str2slice' );
 * Interface describing the `base` namespace.
 */
 interface Namespace {
+	/**
+	* Creates a MultiSlice object from a list of MultiSlice constructor arguments.
+	*
+	* @param args - list of constructor arguments
+	* @returns MultiSlice object
+	*
+	* @example
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = ns.args2multislice( [ void 0, new Slice( 0, 10, 1 ) ] );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ null, <Slice> ]
+	*
+	* @example
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = ns.args2multislice( [ new Slice( 0, 10, 1 ), void 0 ] );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ <Slice>, null ]
+	*
+	* @example
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = ns.args2multislice( [ new Slice( 0, 10, 1 ), void 0, void 0, new Slice( 0, 10, 1 ) ] );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ <Slice>, null, null, <Slice> ]
+	*
+	* @example
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = ns.args2multislice( [ void 0, new Slice( 0, 10, 1 ), null,  void 0, new Slice( 2, 9, 2 ), null, void 0 ] );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ null, <Slice>, null, null, <Slice>, null, null ]
+	*/
+	args2multislice: typeof args2multislice;
+
 	/**
 	* Returns the number of elements in a normalized slice.
 	*
@@ -120,6 +168,24 @@ interface Namespace {
 	*/
 	sliceLength: typeof sliceLength;
 
+	/**
+	* Returns a list of non-reduced dimensions in an un-normalized multi-slice.
+	*
+	* @param slice - input slice
+	* @returns list of indices
+	*
+	* @example
+	* var MultiSlice = require( `@stdlib/slice/multi` );
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = new MultiSlice( 1, null, 2, void 0, new Slice( 0, 10, 1 ) );
+	* // returns <MultiSlice>
+	*
+	* var indices = ns.nonreducedDimensions( s );
+	* // returns [ 1, 3, 4 ]
+	*/
+	nonreducedDimensions: typeof nonreducedDimensions;
+
 	/**
 	* Returns a normalized MultiSlice object.
 	*
@@ -257,6 +323,64 @@ interface Namespace {
 	*/
 	normalizeSlice: typeof normalizeSlice;
 
+	/**
+	* Returns a list of reduced dimensions in an un-normalized multi-slice.
+	*
+	* @param slice - input slice
+	* @returns list of indices
+	*
+	* @example
+	* var MultiSlice = require( `@stdlib/slice/multi` );
+	* var Slice = require( `@stdlib/slice/ctor` );
+	*
+	* var s = new MultiSlice( 1, null, 2, void 0, new Slice( 0, 10, 1 ) );
+	* // returns <MultiSlice>
+	*
+	* var indices = ns.reducedDimensions( s );
+	* // returns [ 0, 2 ]
+	*/
+	reducedDimensions: typeof reducedDimensions;
+
+	/**
+	* Creates a MultiSlice object from a comma-separated list of string-serialized MultiSlice constructor arguments.
+	*
+	* ## Notes
+	*
+	* -   The function returns `null` if provided an invalid string.
+	*
+	* @param str - input string containing constructor arguments
+	* @returns MultiSlice object (or null)
+	*
+	* @example
+	* var s = ns.sargs2multislice( ',Slice(0,10,1)' );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ null, <Slice> ]
+	*
+	* @example
+	* var s = ns.sargs2multislice( 'Slice(0,10,1),' );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ <Slice>, null ]
+	*
+	* @example
+	* var s = ns.sargs2multislice( 'Slice(0,10,1),,,Slice(0,10,1)' );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ <Slice>, null, null, <Slice> ]
+	*
+	* @example
+	* var s = ns.sargs2multislice( ',Slice(0,10,1),null,,Slice(2,9,2),null,' );
+	* // returns <MultiSlice>
+	*
+	* var data = s.data;
+	* // returns [ null, <Slice>, null, null, <Slice>, null, null ]
+	*/
+	sargs2multislice: typeof sargs2multislice;
+
 	/**
 	* Converts a multidimensional subsequence string to a MultiSlice object.
 	*
@@ -573,7 +697,8 @@ interface Namespace {
 	* @param str - input string
 	* @returns MultiSlice object (or null)
 	*
-	* var s = str2multislice( 'MultiSlice(null,null,null)' );
+	* @example
+	* var s = ns.str2multislice( 'MultiSlice(null,null,null)' );
 	* // returns <MultiSlice>
 	*
 	* var v = s.data;