feat!: update ndarray/base TypeScript declarations

BREAKING CHANGE: add writable parameter to and always return a new ndarray in `removeSingletonDimensions`

To migrate, in order to preserve prior writable behavior, users should set the final parameter equal to a boolean indicating whether the input ndarray is writable. If not, pass `false`; if yes, pass `true`.

To preserve prior behavior in which the input ndarray is returned if it does not have singleton dimensions, use `maybeRemoveSingletonDimensions`.

PR-URL: #10558
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: stdlib-bot

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

@@ -24,6 +24,7 @@ import any = require( '@stdlib/ndarray/base/any' );
 import anyBy = require( '@stdlib/ndarray/base/any-by' );
 import assert = require( '@stdlib/ndarray/base/assert' );
 import assign = require( '@stdlib/ndarray/base/assign' );
+import atleastnd = require( '@stdlib/ndarray/base/atleastnd' );
 import binary = require( '@stdlib/ndarray/base/binary' );
 import binaryInputCastingDataType = require( '@stdlib/ndarray/base/binary-input-casting-dtype' );
 import binaryLoopOrder = require( '@stdlib/ndarray/base/binary-loop-interchange-order' );
@@ -163,6 +164,7 @@ import toFlippedud = require( '@stdlib/ndarray/base/to-flippedud' );
 import toNormalizedIndices = require( '@stdlib/ndarray/base/to-normalized-indices' );
 import toReversed = require( '@stdlib/ndarray/base/to-reversed' );
 import toReversedDimension = require( '@stdlib/ndarray/base/to-reversed-dimension' );
+import toTransposed = require( '@stdlib/ndarray/base/to-transposed' );
 import toUniqueNormalizedIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' );
 import transpose = require( '@stdlib/ndarray/base/transpose' );
 import unary = require( '@stdlib/ndarray/base/unary' );
@@ -180,6 +182,7 @@ import unaryReduceSubarrayBy = require( '@stdlib/ndarray/base/unary-reduce-subar
 import unaryStrided1dDispatch = require( '@stdlib/ndarray/base/unary-strided1d-dispatch' );
 import unaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/unary-strided1d-dispatch-factory' );
 import unaryBlockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
+import unflattenShape = require( '@stdlib/ndarray/base/unflatten-shape' );
 import vind2bind = require( '@stdlib/ndarray/base/vind2bind' );
 import wrapIndex = require( '@stdlib/ndarray/base/wrap-index' );
 import zeros = require( '@stdlib/ndarray/base/zeros' );
@@ -301,6 +304,27 @@ interface Namespace {
 	*/
 	assign: typeof assign;
 
+	/**
+	* Converts a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.
+	*
+	* @param ndims - minimum number of dimensions
+	* @param arrays - array-like object containing a list of scalars and/or ndarrays
+	* @returns an array of ndarrays
+	*
+	* @example
+	* var array = require( '@stdlib/ndarray/array' );
+	*
+	* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ] );
+	* // returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]
+	*
+	* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] );
+	* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	*
+	* var out = ns.atleastnd( 3, [ x, y ] );
+	* // returns [ <ndarray>, <ndarray> ]
+	*/
+	atleastnd: typeof atleastnd;
+
 	/**
 	* Applies a binary callback to elements in input ndarrays and assigns results to elements in an output ndarray.
 	*
@@ -3378,14 +3402,14 @@ interface Namespace {
 	quinaryBlockSize: typeof quinaryBlockSize;
 
 	/**
-	* Returns an array without singleton dimensions.
+	* Returns an ndarray without singleton dimensions.
 	*
 	* ## Notes
 	*
-	* -   If a provided ndarray does not have any singleton dimensions, the function returns the provided ndarray unchanged.
-	* -   If a provided ndarray does have singleton dimensions, the function returns a new ndarray view.
+	* -   The function always returns a new ndarray instance even if the input ndarray does not contain any singleton dimensions.
 	*
 	* @param x - input array
+	* @param writable - boolean indicating whether a returned array should be writable
 	* @returns squeezed array
 	*
 	* @example
@@ -3394,28 +3418,10 @@ interface Namespace {
 	* var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
 	*     'ndmin': 5
 	* });
-	* // returns <ndarray>
-	*
-	* var shx = x.shape;
-	* // returns [ 1, 1, 1, 2, 2 ]
-	*
-	* var y = ns.removeSingletonDimensions( x );
-	* // returns <ndarray>
-	*
-	* var shy = y.shape;
-	* // returns [ 2, 2 ]
-	*
-	* var v = y.get( 0, 0 );
-	* // returns 1
-	*
-	* v = y.get( 0, 1 );
-	* // returns 2
-	*
-	* v = y.get( 1, 0 );
-	* // returns 3
+	* // returns <ndarray>[ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ]
 	*
-	* v = y.get( 1, 1 );
-	* // returns 4
+	* var y = ns.removeSingletonDimensions( x, false );
+	* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 	*/
 	removeSingletonDimensions: typeof removeSingletonDimensions;
 
@@ -4598,6 +4604,23 @@ interface Namespace {
 	*/
 	toReversedDimension: typeof toReversedDimension;
 
+	/**
+	* Returns a new ndarray containing the elements of an input ndarray but whose last two dimensions are transposed.
+	*
+	* @param x - input array
+	* @returns output ndarray
+	*
+	* @example
+	* var array = require( '@stdlib/ndarray/array' );
+	*
+	* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] );
+	* // returns <ndarray>[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]
+	*
+	* var out = ns.toTransposed( x );
+	* // returns <ndarray>[ [ 1, 4 ], [ 2, 5 ], [ 3, 6 ] ]
+	*/
+	toTransposed: typeof toTransposed;
+
 	/**
 	* Returns a list of unique indices after normalizing to the interval `[0,max]`.
 	*
@@ -5198,6 +5221,29 @@ interface Namespace {
 	*/
 	unaryBlockSize: typeof unaryBlockSize;
 
+	/**
+	* Expands a dimension over multiple dimensions.
+	*
+	* @param shape - array shape
+	* @param dim - dimension to be unflattened
+	* @param sizes - new shape of the unflattened dimension
+	* @returns unflattened shape
+	*
+	* @example
+	* var sh = ns.unflattenShape( [ 6, 2, 1 ], 0, [ 3, 2 ] );
+	* // returns [ 3, 2, 2, 1 ]
+	*
+	* @example
+	* var o = [ 0, 0, 0, 0 ];
+	*
+	* var out = ns.unflattenShape.assign( [ 6, 2, 1 ], 0, [ 3, 2 ], o );
+	* // returns [ 3, 2, 2, 1 ]
+	*
+	* var bool = ( out === o );
+	* // returns true
+	*/
+	unflattenShape: typeof unflattenShape;
+
 	/**
 	* Converts a linear index in an array view to a linear index in an underlying data buffer.
 	*