Auto-generated commit

decorate-after/docs/types/index.d.ts

@@ -110,6 +110,7 @@ interface Decorator {
 	* // returns 2
 	*/
 	<T extends Array<any>, U>( fcn: ( ...args: T ) => U, arity: number, after: ( v: U ) => void, thisArg?: any ): ( ...args: T ) => U; // tslint-disable-line max-line-length
+
 	/**
 	* Uses code generation to decorate a provided function such that the function's return value is provided as an argument to another function.
 	*

decorate-after/lib/factory.js

@@ -207,6 +207,9 @@ function decorateAfter( fcn, arity, after, thisArg ) {
 	// Close the outer function:
 	f += '}';
 
+	// Add a source directive for debugging:
+	f += '//# sourceURL=decorateAfter.factory.js';
+
 	// Create the function the global scope:
 	return (new Function( f ))()( fcn, after, thisArg );
 }

decorate-after/lib/main.js

@@ -163,7 +163,7 @@ function decorateAfter( fcn, arity, after, thisArg ) {
 		var args;
 		var i;
 
-		// NOTE: the use of a `for` loop is intentional (both here and below), as JavaScript does not require that only a fix number of arguments be provided; the number of provided arguments may be more or less than the signature specifies.
+		// NOTE: the use of a `for` loop is intentional (both here and below), as JavaScript does not require that only a fixed number of arguments be provided; the number of provided arguments may be more or less than the signature specifies.
 
 		args = [];
 		for ( i = 0; i < arguments.length; i++ ) {

lib/index.js

@@ -1741,6 +1741,15 @@ setReadOnly( utils, 'tabulate', require( './../tabulate' ) );
 */
 setReadOnly( utils, 'tabulateBy', require( './../tabulate-by' ) );
 
+/**
+* @name thunk
+* @memberof utils
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/utils/thunk}
+*/
+setReadOnly( utils, 'thunk', require( './../thunk' ) );
+
 /**
 * @name timeit
 * @memberof utils

thunk/README.md

@@ -0,0 +1,134 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2022 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.
+
+-->
+
+# thunk
+
+> Generate a [thunk][thunk].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var thunk = require( '@stdlib/utils/thunk' );
+```
+
+#### thunk( fcn\[, ...args] )
+
+Returns a [thunk][thunk] (i.e., an anonymous function having arity `0` and which invokes a provided function with specified arguments).
+
+```javascript
+var add = require( '@stdlib/math/base/ops/add' );
+
+var f = thunk( add, 2.0, 3.0 );
+// returns <Function>
+
+var v = f();
+// returns 5
+
+// ...
+
+v = f();
+// returns 5
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var add = require( '@stdlib/math/base/ops/add' );
+var decorateAfter = require( '@stdlib/utils/decorate-after' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var thunk = require( '@stdlib/utils/thunk' );
+
+function log( v ) {
+    console.log( v );
+}
+
+// Create a PRNG for generating uniformly distributed pseudorandom integers:
+var randi = discreteUniform( 100, 1000 );
+
+// Randomly delay evaluation of various thunks...
+var i;
+for ( i = 0; i < 10; i++ ) {
+    setTimeout( decorateAfter( thunk( add, i, i+1 ), 0, log ), randi() );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- 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">
+
+[thunk]: https://en.wikipedia.org/wiki/Thunk
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

thunk/benchmark/benchmark.js

@@ -0,0 +1,72 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 isFunction = require( '@stdlib/assert/is-function' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var abs = require( '@stdlib/math/base/special/abs' );
+var pkg = require( './../package.json' ).name;
+var thunk = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var out;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = thunk( abs, -0.0 );
+		if ( typeof out !== 'function' ) {
+			b.fail( 'should return a function' );
+		}
+	}
+	b.toc();
+	if ( !isFunction( out ) ) {
+		b.fail( 'should return a function' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::thunk', function benchmark( b ) {
+	var fcn;
+	var out;
+	var i;
+
+	fcn = thunk( abs, -0.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = fcn(); // NOTE: this may get optimized away as returning the same value for each loop iteration
+		if ( out !== out ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( out ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

thunk/docs/repl.txt

@@ -0,0 +1,28 @@
+
+{{alias}}( fcn[, ...args] )
+    Returns a thunk.
+
+    Parameters
+    ----------
+    fcn: Function
+        Function to convert to a thunk.
+
+    args: ...any (optional)
+        Function arguments.
+
+    Returns
+    -------
+    out: Function
+        Thunk.
+
+    Examples
+    --------
+    > var fcn = {{alias}}( {{alias:@stdlib/math/base/ops/add}}, 2, 3 );
+    > var v = fcn()
+    5
+    > v = fcn()
+    5
+
+    See Also
+    --------
+

thunk/docs/types/index.d.ts

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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: 2.0
+
+/**
+* Returns a thunk.
+*
+* @param fcn - function to convert to a thunk
+* @param args - function args
+* @returns thunk
+*
+* @example
+* var add = require( `@stdlib/math/base/ops/add` );
+*
+* var f = thunk( add, 2, 3 );
+* // returns <Function>
+*
+* // ...
+*
+* // Evaluate the thunk:
+* var v = f();
+* // returns 5
+*/
+declare function thunk<T extends Array<any>, U>( fcn: ( ...args: T ) => U, ...args: T ): () => U; // tslint-disable-line max-line-length
+
+
+// EXPORTS //
+
+export = thunk;

thunk/docs/types/test.ts

@@ -0,0 +1,58 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 thunk = require( './index' );
+
+
+// TESTS //
+
+// The function returns a function...
+{
+	thunk<[], number>( (): number => 2 ); // $ExpectType () => number
+	thunk<Array<number>, number>( ( x: number ): number => x, 2 ); // $ExpectType () => number
+	thunk<[number, number], number>( ( x: number, y: number ): number => x + y, 2, 3 ); // $ExpectType () => number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a function...
+{
+	thunk( true ); // $ExpectError
+	thunk( false ); // $ExpectError
+	thunk( 5 ); // $ExpectError
+	thunk( [] ); // $ExpectError
+	thunk( {} ); // $ExpectError
+	thunk( 'abc' ); // $ExpectError
+
+	thunk( true, 2 ); // $ExpectError
+	thunk( false, 2 ); // $ExpectError
+	thunk( 5, 2 ); // $ExpectError
+	thunk( [], 2 ); // $ExpectError
+	thunk( {}, 2 ); // $ExpectError
+	thunk( 'abc', 2 ); // $ExpectError
+
+	thunk( true, 2, 3 ); // $ExpectError
+	thunk( false, 2, 3 ); // $ExpectError
+	thunk( 5, 2, 3 ); // $ExpectError
+	thunk( [], 2, 3 ); // $ExpectError
+	thunk( {}, 2, 3 ); // $ExpectError
+	thunk( 'abc', 2, 3 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an incorrect number of arguments...
+{
+	thunk(); // $ExpectError
+}