feat: update namespace TypeScript declarations

stdlib-bot · kgryte · web-flow · commit 377ae317cf56 · 2023-08-04T09:14:05.000-07:00
PR-URL: stdlib-js#1076 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts
@@ -34,8 +34,18 @@ import copy = require( '@stdlib/array/base/copy' );
 import copyIndexed = require( '@stdlib/array/base/copy-indexed' );
 import filled = require( '@stdlib/array/base/filled' );
 import filledBy = require( '@stdlib/array/base/filled-by' );
+import flatten = require( '@stdlib/array/base/flatten' );
+import flatten2d = require( '@stdlib/array/base/flatten2d' );
+import flatten2dBy = require( '@stdlib/array/base/flatten2d-by' );
+import flatten3d = require( '@stdlib/array/base/flatten3d' );
+import flatten3dBy = require( '@stdlib/array/base/flatten3d-by' );
+import flatten4d = require( '@stdlib/array/base/flatten4d' );
+import flatten4dBy = require( '@stdlib/array/base/flatten4d-by' );
+import flatten5d = require( '@stdlib/array/base/flatten5d' );
+import flatten5dBy = require( '@stdlib/array/base/flatten5d-by' );
 import getter = require( '@stdlib/array/base/getter' );
 import incrspace = require( '@stdlib/array/base/incrspace' );
+import last = require( '@stdlib/array/base/last' );
 import linspace = require( '@stdlib/array/base/linspace' );
 import logspace = require( '@stdlib/array/base/logspace' );
 import nCartesianProduct = require( '@stdlib/array/base/n-cartesian-product' );
@@ -308,6 +318,278 @@ interface Namespace {
 	*/
 	filledBy: typeof filledBy;
 
+	/**
+	* Flattens an n-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten( x, [ 2, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten( x, [ 2, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten: typeof flatten;
+
+	/**
+	* Flattens a two-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten2d( x, [ 2, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten2d( x, [ 2, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten2d: typeof flatten2d;
+
+	/**
+	* Flattens a two-dimensional nested array according to a callback function.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @param clbk - callback function
+	* @param thisArg - callback execution context
+	* @returns flattened array
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten2dBy( x, [ 2, 2 ], false, scale );
+	* // returns [ 2, 4, 6, 8 ]
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
+	*
+	* var out = ns.flatten2dBy( x, [ 2, 2 ], true, scale );
+	* // returns [ 2, 6, 4, 8 ]
+	*/
+	flatten2dBy: typeof flatten2dBy;
+
+	/**
+	* Flattens a three-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ];
+	*
+	* var out = ns.flatten3d( x, [ 2, 1, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ];
+	*
+	* var out = ns.flatten3d( x, [ 2, 1, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten3d: typeof flatten3d;
+
+	/**
+	* Flattens a three-dimensional nested array according to a callback function.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @param clbk - callback function
+	* @param thisArg - callback execution context
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ];
+	*
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var out = ns.flatten3dBy( x, [ 2, 1, 2 ], false, scale );
+	* // returns [ 2, 4, 6, 8 ]
+	*
+	* @example
+	* var x = [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ];
+	*
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var out = ns.flatten3dBy( x, [ 2, 1, 2 ], true, scale );
+	* // returns [ 2, 6, 4, 8 ]
+	*/
+	flatten3dBy: typeof flatten3dBy;
+
+	/**
+	* Flattens a four-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ [ [ 1, 2 ] ] ], [ [ [ 3, 4 ] ] ] ];
+	*
+	* var out = ns.flatten4d( x, [ 2, 1, 1, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ [ [ 1, 2 ] ] ], [ [ [ 3, 4 ] ] ] ];
+	*
+	* var out = ns.flatten4d( x, [ 2, 1, 1, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten4d: typeof flatten4d;
+
+	/**
+	* Flattens a four-dimensional nested array according to a callback function.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ [ [ 1, 2 ] ] ], [ [ [ 3, 4 ] ] ] ];
+	*
+	* var out = ns.flatten4dBy( x, [ 2, 1, 1, 2 ], false, scale );
+	* // returns [ 2, 4, 6, 8 ]
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ [ [ 1, 2 ] ] ], [ [ [ 3, 4 ] ] ] ];
+	*
+	* var out = ns.flatten4dBy( x, [ 2, 1, 1, 2 ], true, scale );
+	* // returns [ 2, 6, 4, 8 ]
+	*/
+	flatten4dBy: typeof flatten4dBy;
+
+	/**
+	* Flattens a five-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = ns.flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = ns.flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten5d: typeof flatten5d;
+
+	/**
+	* Flattens a five-dimensional nested array according to a callback function.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @param clbk - callback function
+	* @param thisArg - callback execution context
+	* @returns flattened array
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = ns.flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* function scale( v ) {
+	*     return v * 2;
+	* }
+	*
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = ns.flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	flatten5dBy: typeof flatten5dBy;
+
 	/**
 	* Returns an accessor function for retrieving an element from an indexed array-like object.
 	*
@@ -339,6 +621,20 @@ interface Namespace {
 	*/
 	incrspace: typeof incrspace;
 
+	/**
+	* Returns the last element of an array-like object.
+	*
+	* @param arr - input array
+	* @returns last element
+	*
+	* @example
+	* var arr = [ 1, 2, 3 ];
+	*
+	* var out = ns.last( x );
+	* // returns 3
+	*/
+	last: typeof last;
+
 	/**
 	* Generates a linearly spaced numeric array.
 	*
diff --git a/lib/node_modules/@stdlib/nlp/docs/types/index.d.ts b/lib/node_modules/@stdlib/nlp/docs/types/index.d.ts
@@ -26,6 +26,7 @@ import expandContractions = require( '@stdlib/nlp/expand-contractions' );
 import lda = require( '@stdlib/nlp/lda' );
 import ordinalize = require( '@stdlib/nlp/ordinalize' );
 import porterStemmer = require( '@stdlib/nlp/porter-stemmer' );
+import sentencize = require( '@stdlib/nlp/sentencize' );
 import tokenize = require( '@stdlib/nlp/tokenize' );
 
 /**
@@ -142,6 +143,29 @@ interface Namespace {
 	*/
 	porterStemmer: typeof porterStemmer;
 
+	/**
+	* Splits a string into an array of sentences.
+	*
+	* @param str - input string
+	* @returns array of sentences
+	*
+	* @example
+	* var str = 'Hello World! How are you?';
+	* var out = ns.sentencize( str );
+	* // returns [ 'Hello World!', 'How are you?' ]
+	*
+	* @example
+	* var str = '';
+	* var out = ns.sentencize( str );
+	* // returns []
+	*
+	* @example
+	* var str = 'Hello Mrs. Maple, could you call me back?';
+	* var out = ns.sentencize( str );
+	* // returns [ 'Hello Mrs. Maple, could you call me back?' ]
+	*/
+	sentencize: typeof sentencize;
+
 	/**
 	* Tokenize a string.
 	*
diff --git a/lib/node_modules/@stdlib/object/docs/types/index.d.ts b/lib/node_modules/@stdlib/object/docs/types/index.d.ts
@@ -21,12 +21,39 @@
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-file-line-count */
 
+import assign = require( '@stdlib/object/assign' );
 import Object = require( '@stdlib/object/ctor' );
 
 /**
 * Interface describing the `object` namespace.
 */
 interface Namespace {
+	/**
+	* Copies own enumerable properties from one or more source objects to a target object.
+	*
+	* ## Notes
+	*
+	* -   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
+	* -   The target object is mutated.
+	*
+	* @param target - target object
+	* @param source - source object(s)
+	* @throws first argument must not be null or undefined
+	* @returns target object
+	*
+	* @example
+	* var obj1 = {
+	*     'a': 'beep'
+	* };
+	* var obj2 = {
+	*     'b': 'boop'
+	* };
+	*
+	* var out = ns.assign( obj1, obj2 );
+	* // returns { 'a': 'beep', 'b': 'boop' }
+	*/
+	assign: typeof assign;
+
 	/**
 	* Returns an object.
 	*
diff --git a/lib/node_modules/@stdlib/stats/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/docs/types/index.d.ts
