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

Author: kgryte

.github/workflows/labeler_needs_changes.yml

@@ -33,8 +33,8 @@ jobs:
     # Define job name:
     name: 'Add "Needs Changes" Label when Reviewer Requests Changes'
 
-    # Only run this job if the reviewer requested changes:
-    if: ${{ github.event.review.state == 'changes_requested' }}
+    # Only run this job if the reviewer requested changes (but do not run on forks due to missing permissions):
+    if: ${{ github.repository == 'stdlib-js/stdlib' && github.event.review.state == 'changes_requested' }}
 
     # Define job permissions:
     permissions:

lib/node_modules/@stdlib/array/base/cartesian-square/README.md

@@ -82,6 +82,14 @@ var out = cartesianSquare( x );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/cartesian-square`][@stdlib/array/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
+-   <span class="package-name">[`@stdlib/array/base/cartesian-power`][@stdlib/array/base/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
+-   <span class="package-name">[`@stdlib/array/base/cartesian-product`][@stdlib/array/base/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
+
 </section>
 
 <!-- /.related -->
@@ -92,6 +100,16 @@ var out = cartesianSquare( x );
 
 [cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
 
+<!-- <related-links> -->
+
+[@stdlib/array/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-square
+
+[@stdlib/array/base/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-power
+
+[@stdlib/array/base/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-product
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/math/iter/sequences/tribonacci/README.md

@@ -204,10 +204,10 @@ while ( true ) {
 
 [@stdlib/math/base/special/tribonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/tribonacci
 
-[@stdlib/math/iter/sequences/lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/iter/sequences/lucas
-
 [@stdlib/math/base/special/fibonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/fibonacci
 
+[@stdlib/math/iter/sequences/lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/iter/sequences/lucas
+
 <!-- </related-links> -->
 
 </section>

lib/node_modules/@stdlib/math/strided/special/bessely0-by/README.md

@@ -229,6 +229,14 @@ console.log( y );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/strided/special/besselj0-by`][@stdlib/math/strided/special/besselj0-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the first kind of order zero for each element retrieved from an input strided array via a callback function.</span>
+-   <span class="package-name">[`@stdlib/math/strided/special/besselj1-by`][@stdlib/math/strided/special/besselj1-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the first kind of order one for each element retrieved from an input strided array via a callback function.</span>
+-   <span class="package-name">[`@stdlib/math/strided/special/bessely1-by`][@stdlib/math/strided/special/bessely1-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the second kind of order one for each element retrieved from an input strided array via a callback function.</span>
+
 </section>
 
 <!-- /.related -->
@@ -243,6 +251,16 @@ console.log( y );
 
 [@stdlib/math/base/special/bessely0]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/bessely0
 
+<!-- <related-links> -->
+
+[@stdlib/math/strided/special/besselj0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj0-by
+
+[@stdlib/math/strided/special/besselj1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj1-by
+
+[@stdlib/math/strided/special/bessely1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely1-by
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/stats/base/dists/f/mean/README.md

@@ -142,6 +142,102 @@ for ( i = 0; i < 10; i++ ) {
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- 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 -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/f/mean.h"
+```
+
+#### stdlib_base_dists_f_mean( d1, d2 )
+
+Evaluates the [expected value][expected-value] of a [F][f-distribution] distribution with parameters `d1` (numerator degrees of freedom) and `d2` (denominator degrees of freedom).
+
+```c
+double out = stdlib_base_dists_f_mean( 3.0, 5.0 );
+// returns ~1.667
+```
+
+The function accepts the following arguments:
+
+-   **d1**: `[in] double` numerator degrees of freedom.
+-   **d2**: `[in] double` denominator degrees of freedom.
+
+```c
+double stdlib_base_dists_f_mean( const double d1, const double d2 );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/f/mean.h"
+#include "stdlib/constants/float64/eps.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+static double random_uniform( const double min, const double max ) {
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+    return min + ( v*(max-min) );
+}
+
+int main( void ) {
+    double d1;
+    double d2;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        d1 = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
+        d2 = random_uniform( 0.0, 10.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
+        y = stdlib_base_dists_f_mean( d1, d2 );
+        printf( "d1: %lf, d2: %lf, E(X;d1,d2): %lf\n", d1, d2, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- 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">

lib/node_modules/@stdlib/stats/base/dists/f/mean/benchmark/benchmark.js

@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var Float64Array = require( '@stdlib/array/float64' );
 var EPS = require( '@stdlib/constants/float64/eps' );
 var pkg = require( './../package.json' ).name;
 var mean = require( './../lib' );
@@ -31,16 +32,23 @@ var mean = require( './../lib' );
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
+	var len;
 	var d1;
 	var d2;
 	var y;
 	var i;
 
+	len = 100;
+	d1 = new Float64Array( len );
+	d2 = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		d1[ i ] = ( randu() * 10.0 ) + EPS;
+		d2[ i ] = ( randu() * 10.0 ) + 2.0 + EPS;
+	}
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		d1 = ( randu()*10.0 ) + EPS;
-		d2 = ( randu()*10.0 ) + 2.0 + EPS;
-		y = mean( d1, d2 );
+		y = mean( d1[ i % len ], d2[ i % len ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/stats/base/dists/f/mean/benchmark/benchmark.native.js

@@ -0,0 +1,71 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var EPS = require( '@stdlib/constants/float64/eps' );
+var Float64Array = require( '@stdlib/array/float64' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var mean = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( mean instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var len;
+	var d1;
+	var d2;
+	var y;
+	var i;
+
+	len = 100;
+	d1 = new Float64Array( len );
+	d2 = new Float64Array( len );
+	for ( i = 0; i < len; i++ ) {
+		d1[ i ] = ( randu() * 10.0 ) + EPS;
+		d2[ i ] = ( randu() * 10.0 ) + 2.0 + EPS;
+	}
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = mean( d1[ i % len ], d2[ i % len ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});