Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

kgryte · kgryte · commit cb29bbfe170d · 2018-06-28T13:47:07.000-07:00
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/lib/main.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/lib/main.js
@@ -79,16 +79,19 @@ function main( context ) {
 	* @param {ASTNode} node - function node
 	*/
 	function registerFunction( node ) {
-		var name = node.id.name;
-		if ( name ) {
-			if ( !hasOwnProp( functionHash, name ) ) {
-				functionHash[ name ] = {
-					'name': name,
-					'start': node.start,
-					'end': node.end,
-					'loc': node.loc,
-					'throwAnnotations': extractThrowsAnnotations( node )
-				};
+		var name;
+		if ( node.id ) {
+			name = node.id.name;
+			if ( name ) {
+				if ( !hasOwnProp( functionHash, name ) ) {
+					functionHash[ name ] = {
+						'name': name,
+						'start': node.start,
+						'end': node.end,
+						'loc': node.loc,
+						'throwAnnotations': extractThrowsAnnotations( node )
+					};
+				}
 			}
 		}
 	}
@@ -163,15 +166,19 @@ function main( context ) {
 	* @param {Object} fcn - function metadata
 	*/
 	function validateFunction( fcn ) {
-		var annotations = unique( fcn.throwAnnotations );
-		var statements = unique( fcn.throwStatements );
+		var annotations;
+		var statements;
 		var stmt;
 		var i;
 
-		for ( i = 0; i < statements.length; i++ ) {
-			stmt = statements[ i ];
-			if ( !contains( annotations, stmt ) ) {
-				report( fcn, stmt );
+		if ( fcn.throwStatements.length > 0 ) {
+			annotations = unique( fcn.throwAnnotations.sort() );
+			statements = unique( fcn.throwStatements.sort() );
+			for ( i = 0; i < statements.length; i++ ) {
+				stmt = statements[ i ];
+				if ( !contains( annotations, stmt ) ) {
+					report( fcn, stmt );
+				}
 			}
 		}
 	}
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/lib/unique.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/lib/unique.js
@@ -18,38 +18,32 @@
 
 'use strict';
 
+// MAIN //
+
 /**
-* Returns the unique elements in an array.
+* Mutates a sorted input array to only contain unique values.
 *
 * @private
-* @param {Array} arr - input array
-* @returns {Array} array of unique elements
+* @param {Array} arr - sorted array
+* @returns {Array} input array
 */
 function unique( arr ) {
-	var len;
-	var out;
-	var val;
+	var v;
 	var i;
 	var j;
 
-	// Copy the array to avoid mutation:
-	out = Array.prototype.slice.call( arr );
-	len = out.length;
-
-	// Sort array in ascending order:
-	out.sort();
-
 	// Loop through the array, only incrementing a pointer when successive values are different. When a succeeding value is different, move the pointer and set the next value. In the trivial case where all array elements are unique, we incur a slight penalty in resetting the element value for each unique value. In other cases, we simply move a unique value to a new position in the array. The end result is a sorted array with unique values.
-	for ( i = 1, j = 0; i < len; i++ ) {
-		val = out[ i ];
-		if ( out[ j ] !== val ) {
+	for ( i = 1, j = 0; i < arr.length; i++ ) {
+		v = arr[ i ];
+		if ( arr[ j ] !== v ) {
 			j += 1;
-			out[ j ] = val;
+			arr[ j ] = v;
 		}
 	}
 	// Truncate the array:
-	out.length = j+1;
-	return out;
+	arr.length = j+1;
+
+	return arr;
 }
 
 
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/test/fixtures/valid.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-require-throws-tags/test/fixtures/valid.js
@@ -185,6 +185,35 @@ test = {
 };
 valid.push( test );
 
+test = {
+	'code': [
+		'/**',
+		'* Invokes a function once for each element in a collection and updates a collection in-place, iterating from right to left.',
+		'*',
+		'* @param {Collection} collection - input collection',
+		'* @param {Options} [options] - function options',
+		'* @param {*} [options.thisArg] - execution context',
+		'* @param {PositiveInteger} [options.limit] - maximum number of pending invocations at any one time',
+		'* @param {boolean} [options.series=false] - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection',
+		'* @param {Function} fcn - function to invoke for each element in a collection',
+		'* @param {Callback} done - function to invoke upon completion',
+		'* @throws {TypeError} first argument must be a collection',
+		'* @throws {TypeError} options argument must be an object',
+		'* @throws {TypeError} must provide valid options',
+		'* @throws {TypeError} second-to-last argument must be a function',
+		'* @throws {TypeError} last argument must be a function',
+		'* @returns {void}',
+		'*/',
+		'function inmapRightAsync( collection, options, fcn, done ) {',
+		'  if ( arguments.length < 4 ) {',
+		'    return factory( options )( collection, fcn );',
+		'  }',
+		'  factory( options, fcn )( collection, done );',
+		'}'
+	].join( '\n' )
+};
+valid.push( test );
+
 
 // EXPORTS //
 
diff --git a/lib/node_modules/@stdlib/nlp/lda/lib/lda.js b/lib/node_modules/@stdlib/nlp/lda/lib/lda.js
@@ -171,6 +171,8 @@ function lda( documents, K, options ) {
 	* @private
 	* @param {NonNegativeInteger} k - topic
 	* @param {PositiveInteger} [no=10] - number of terms
+	* @throws {TypeError} first argument must be a nonnegative integer smaller than the total number of topics
+	* @throws {TypeError} second argument must be a positive integer
 	* @returns {Array} word probability array
 	*/
 	function getTerms( k, no ) {
diff --git a/lib/node_modules/@stdlib/stats/kde2d/docs/repl.txt b/lib/node_modules/@stdlib/stats/kde2d/docs/repl.txt
diff --git a/lib/node_modules/@stdlib/stats/kstest/lib/get_cdf.js b/lib/node_modules/@stdlib/stats/kstest/lib/get_cdf.js
@@ -30,6 +30,7 @@ var CDF = require( './cdf.js' );
 *
 * @private
 * @param {string} name - distribution name
+* @throws {Error} unsupported/unrecognized distribution name
 * @returns {Function} cumulative distribution function (CDF)
 */
 function getCDF( name ) {
diff --git a/lib/node_modules/@stdlib/stats/kstest/lib/print.js b/lib/node_modules/@stdlib/stats/kstest/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare
diff --git a/lib/node_modules/@stdlib/stats/ttest/lib/print.js b/lib/node_modules/@stdlib/stats/ttest/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare
diff --git a/lib/node_modules/@stdlib/stats/ttest2/lib/print.js b/lib/node_modules/@stdlib/stats/ttest2/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options has to be simple object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare
diff --git a/lib/node_modules/@stdlib/stats/ztest/lib/print.js b/lib/node_modules/@stdlib/stats/ztest/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare
diff --git a/lib/node_modules/@stdlib/stats/ztest2/lib/print.js b/lib/node_modules/@stdlib/stats/ztest2/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare
diff --git a/lib/node_modules/@stdlib/utils/bifurcate/lib/bifurcate.js b/lib/node_modules/@stdlib/utils/bifurcate/lib/bifurcate.js
@@ -38,8 +38,9 @@ var returnPairs = require( './return_pairs.js' );
 * @param {Collection} filter - collection indicating which group an element in the input collection belongs to
 * @throws {TypeError} first argument must be a collection
 * @throws {TypeError} options argument must be an object
-* @throws {TypeError} last argument must be a collection
 * @throws {TypeError} must provide valid options
+* @throws {TypeError} last argument must be a collection
+* @throws {RangeError} first and last arguments must be the same length
 * @returns {(Array<Array>|Array)} results
 *
 * @example
diff --git a/lib/node_modules/@stdlib/utils/group/lib/group.js b/lib/node_modules/@stdlib/utils/group/lib/group.js
@@ -40,6 +40,7 @@ var returnPairs = require( './return_pairs.js' );
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} last argument must be a collection
 * @throws {TypeError} must provide valid options
+* @throws {RangeError} first and last arguments must be the same length
 * @returns {Object} group results
 *
 * @example

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ var CDF = require( './cdf.js' );`
`30`	`30`	`*`
`31`	`31`	`* @private`
`32`	`32`	`* @param {string} name - distribution name`
	`33`	`+* @throws {Error} unsupported/unrecognized distribution name`
`33`	`34`	`* @returns {Function} cumulative distribution function (CDF)`
`34`	`35`	`*/`
`35`	`36`	`function getCDF( name ) {`