Merge branch 'develop' into number/float32/base/signbit

Author: stdlib-bot

.github/workflows/lint_copyright_years.yml

@@ -0,0 +1,114 @@
+#/
+# @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.
+#/
+
+# Workflow name:
+name: 'Lint Copyright Years in Newly Added Files'
+
+# Workflow triggers:
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+# Global permissions:
+permissions:
+  # Allow read-only access to the repository contents:
+  contents: read
+
+# Workflow jobs:
+jobs:
+  # Define a job for linting copyright years in newly added files:
+  lint:
+    name: 'Lint Copyright Years'
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        # Pin action to full length commit SHA
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          # Specify whether to remove untracked files before checking out the repository:
+          clean: true
+
+          # Limit clone depth to the last 1000 commits:
+          fetch-depth: 100
+
+          # Specify whether to download Git-LFS files:
+          lfs: false
+        timeout-minutes: 10
+
+      # Get list of newly added files:
+      - name: 'Get list of newly added files'
+        id: added-files
+        run: |
+          page=1
+          files=""
+          while true; do
+              new_files=$(curl -s \
+                -H "Accept: application/vnd.github.v3+json" \
+                -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "${{ github.api_url }}/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files?page=$page&per_page=100" \
+                | jq -r '.[] | select(.status == "added") | .filename')
+              if [ -z "$new_files" ]; then
+                  break
+              fi
+              files="$files $new_files"
+              page=$((page+1))
+          done
+          files=$(echo "$files" | tr '\n' ' ' | sed 's/^ //;s/ $//')
+          echo "files=${files}" >> $GITHUB_OUTPUT
+
+      # Check copyright years in newly added files:
+      - name: 'Check copyright years'
+        run: |
+          current_year=$(date +"%Y")
+          files="${{ steps.added-files.outputs.files }}"
+          exit_code=0
+
+          echo "## 📄 Copyright Year Check Results" >> $GITHUB_STEP_SUMMARY
+          echo "_Only newly added files are checked for the current year in the copyright notice._" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          if [[ -z "$files" ]]; then
+              echo "No newly added files to check." >> $GITHUB_STEP_SUMMARY
+              exit 0
+          fi
+
+          for file in $files; do
+              if [[ ! -f "$file" ]]; then
+                  continue
+              fi
+
+              # Check if file contains stdlib copyright notice:
+              year=$(grep -oP \
+                'Copyright \(c\) \K[0-9]{4}(?= The Stdlib Authors\.)' \
+                "$file")
+
+              if [[ -n "$year" ]]; then
+                  if [[ "$year" == "$current_year" ]]; then
+                      echo "- ✅ \`$file\`: Year is correct (**$year**)" >> $GITHUB_STEP_SUMMARY
+                  else
+                      echo "- ❌ **Error**: \`$file\` — Expected year **$current_year**, found **$year**" >> $GITHUB_STEP_SUMMARY
+                      exit_code=1
+                  fi
+              else
+                  echo "- ⚠️ No copyright notice found in \`$file\`" >> $GITHUB_STEP_SUMMARY
+              fi
+          done
+
+          exit $exit_code

lib/node_modules/@stdlib/math/base/special/bernoulli/README.md

@@ -43,7 +43,7 @@ var v = bernoulli( 0 );
 // returns 1.0
 
 v = bernoulli( 1 );
-// returns 0.0
+// returns 0.5
 
 v = bernoulli( 2 );
 // returns ~0.167
@@ -158,7 +158,7 @@ double out = stdlib_base_bernoulli( 0 );
 // returns 1.0
 
 out = stdlib_base_bernoulli( 1 );
-// returns 0.0
+// returns 0.5
 ```
 
 The function accepts the following arguments:

lib/node_modules/@stdlib/math/base/special/bernoulli/benchmark/benchmark.js

@@ -21,8 +21,7 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
-var floor = require( '@stdlib/math/base/special/floor' );
+var randu = require( '@stdlib/random/array/discrete-uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
 var bernoulli = require( './../lib' );
@@ -35,10 +34,11 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = randu( 100, 0, 500 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = floor( randu()*500.0 );
-		y = bernoulli( x );
+		y = bernoulli( x[ i % x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/math/base/special/bernoulli/benchmark/benchmark.native.js

@@ -22,8 +22,7 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
-var floor = require( '@stdlib/math/base/special/floor' );
+var randu = require( '@stdlib/random/array/discrete-uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
@@ -44,10 +43,11 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = randu( 100, 0, 500 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = floor( randu() * 500.0 );
-		y = bernoulli( x );
+		y = bernoulli( x[ i % x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/math/base/special/bernoulli/benchmark/c/native/benchmark.c

@@ -91,15 +91,18 @@ static double rand_double( void ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	double x;
+	double x[ 100 ];
 	double y;
 	double t;
 	int i;
 
+	for ( i = 0; i < 100; i++ ) {
+		x[ i ] = ( 500.0 * rand_double() );
+	}
+
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		x = ( 500.0 * rand_double() );
-		y = stdlib_base_bernoulli( x );
+		y = stdlib_base_bernoulli( (int)( x[ i % 100 ] ) );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );
 			break;

lib/node_modules/@stdlib/math/base/special/bernoulli/docs/repl.txt

@@ -21,7 +21,7 @@
     > var y = {{alias}}( 0 )
     1.0
     > y = {{alias}}( 1 )
-    0.0
+    0.5
     > y = {{alias}}( 2 )
     ~0.167
     > y = {{alias}}( 3 )

lib/node_modules/@stdlib/math/base/special/bernoulli/docs/types/index.d.ts

@@ -30,7 +30,7 @@
 *
 * @example
 * var y = bernoulli( 1 );
-* // returns 0.0
+* // returns 0.5
 *
 * @example
 * var y = bernoulli( 2 );

lib/node_modules/@stdlib/math/base/special/bernoulli/lib/index.js

@@ -30,7 +30,7 @@
 * // returns 1.0
 *
 * y = bernoulli( 1 );
-* // returns 0.0
+* // returns 0.5
 *
 * y = bernoulli( 2 );
 * // returns ~0.166

lib/node_modules/@stdlib/math/base/special/bernoulli/lib/main.js

@@ -47,7 +47,7 @@ var MAX_BERNOULLI = 258|0; // asm type annotation
 *
 * @example
 * var y = bernoulli( 1 );
-* // returns 0.0
+* // returns 0.5
 *
 * @example
 * var y = bernoulli( 2 );
@@ -85,6 +85,9 @@ function bernoulli( n ) {
 	if ( isnan( n ) || !isNonNegativeInteger( n ) ) {
 		return NaN;
 	}
+	if ( n === 1 ) {
+		return 0.5;
+	}
 	if ( isOdd( n ) ) {
 		return 0.0;
 	}

lib/node_modules/@stdlib/math/base/special/bernoulli/lib/native.js

@@ -37,7 +37,7 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var y = bernoulli( 1 );
-* // returns 0.0
+* // returns 0.5
 *
 * @example
 * var y = bernoulli( 2 );